Skip to content

Commit

Permalink
new roxizenised man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ejardim committed Oct 23, 2024
1 parent 4fcd2b4 commit cd8000e
Show file tree
Hide file tree
Showing 7 changed files with 124 additions and 4 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ tests/wcsam.R
^.*\.Rproj$
^\.Rproj\.user$
docs/
^README\.Rmd$
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ Collate:
'southern_hake-data.R'
'a4amse-sa.R'
'a4aFitCatchDiagn-class.R'
RoxygenNote: 7.2.1
RoxygenNote: 7.3.2
Encoding: UTF-8
20 changes: 20 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# FLa4a 1.9.x:

## NEW FEATURES
- plot for residuals by age
- multisca method to run several sca

## BUG FIXES:
- sca use of covariates fixed

# FLa4a 1.8.x:

## NEW FEATURES
- pearson and raw residuals
- method replaceZeros for stock and index objects
- mse sca now replaces zeros before calling fit

## BUG FIXES:
- problem dealing with iters that don't converged fixed. Related with 'active'.
- sca.sa fixed to be compatible with mse 2.0

# FLa4a 1.6.5:

## NEW FEATURES
Expand Down
55 changes: 55 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# FLa4a

<!-- badges: start -->
<!-- badges: end -->

The goal of FLa4a is to ...

## Installation

You can install the development version of FLa4a from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("flr/FLa4a")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(FLa4a)
## basic example code
```

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}
summary(cars)
```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.

You can also embed plots, for example:

```{r pressure, echo = FALSE}
plot(pressure)
```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# FLa4a
- Version: 1.8.3
- Version: 1.9.0
- Author: Colin P. Millar and Ernesto Jardim
- Maintainer: Ernesto Jardim <ernesto.jardim AT jrc.ec.europa.eu>
- Maintainer: Colin P. Millar <colin.millar AT ices.dk>
- Repository: <https://github.com/flr/FLa4a/>
- Bug reports: <https://github.com/flr/FLa4a/issues>

Expand Down
42 changes: 42 additions & 0 deletions man/multisca.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/plot-methods.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit cd8000e

Please sign in to comment.