files for r4ss package
Clone or download

README.md

r4ss: R code for Stock Synthesis

Build Status

Stock Synthesis is a fisheries stock assessment model written in ADMB by Dr. Rick Methot at the NOAA Northwest Fisheries Science Center. The R code in the r4ss package is based on the original work of Dr. Ian Stewart begun around 2005 and released as an open source R package on CRAN in 2009. The package has benefited from contributions, suggestions, and bug reports from many collaborators and users.

Code available on this website comes with no warranty or guarantee of accuracy. It merely represents an ongoing attempt to integrate output plotting, statistics and diagnostics. It is absolutely necessary that prior to use with a new application, the user checks the output manually to verify that there are no plotting or statistical bugs which could incorrectly represent the output files being analyzed.

Installation

The version of r4ss on CRAN is currently out of date. Therefore, installing directly from GitHub is recommended. This requires installing the devtools package first.

install.packages("devtools")
devtools::install_github("r4ss/r4ss")

Note: devtools may give this message: "WARNING: Rtools is required to build R packages, but is not currently installed." However, Rtools is NOT required for installing r4ss via devtools, so ignore the warning.

Once you have installed the r4ss package, it can be loaded using:

library(r4ss)

To get notifications about r4ss, you can watch this GitHub project or follow messages on the forums on Stock Synthesis VLab (account required).

There is now a basic Vignette, which can be viewed at https://github.com/r4ss/r4ss/blob/master/vignettes/r4ss-intro-vignette.Rmd or built locally on your computer using this command to install the package:

devtools::install_github("r4ss/r4ss", build_vignettes = TRUE)

Changes

See NEWS.md for (not very complete) log of changes, starting with v1.24.0.