Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 1.88 KB

README.md

File metadata and controls

78 lines (54 loc) · 1.88 KB
Raw

gfcmSTAR

gfcmSTAR provides tools that support the Stock Assessment Results (STAR) framework of the General Fisheries Commission for the Mediterranean.

Installation

Personal installation (e.g. laptop)

gfcmSTAR can be installed from GitHub using the install_github command:

library(remotes)
install_github("gfcm/gfcmSTAR")

Site installation (e.g. GFCM RStudio Server)

General users on the GFCM RStudio Server do not need to install the package, since the administrator has already installed the newest version in the site library.

To install the gfcmSTAR package in the site library, the system administrator specifies the 2nd library path:

library(remotes)
install_github("gfcm/gfcmSTAR", lib=.libPaths()[2])

Usage

For a summary of the package:

library(gfcmSTAR)
?gfcmSTAR

A fully annotated script to import and export a large collection of STARs is found here:

import.R

It demonstrates administrative procedures to quality check and handle STAR templates that may contain errors. This script can also be found on the local hard drive:

system.file("scripts/import.R", package="gfcmSTAR")

References

GFCM Stock Assessment Results: https://github.com/gfcm/star

Development

gfcmSTAR is developed openly on GitHub.

Feel free to open an issue there if you encounter problems or have suggestions for future versions.

Note on version numbering

The gfcmSTAR package has a three-part version number: major.minor.patch. These are incremented based on the following rules:

  • MAJOR version when existing user scripts will not give the same output as before
  • MINOR version when there are new functions
  • PATCH version for other improvements