Developers

Here, you will find a guide for users who wish to aid in the development of ss3sim.

Coding style

• Guides
  • Follow the tidyverse style guide
  • References on R package development from Hadley's book R Packages
  • Advanced R
  • CRAN page
  • Semantic versioning
• Code rules
  • Use vapply or lapply instead of sapply because sapply is not consistent in the what class of object it returns (not yet implemented in the package)
  • Use [ rather than subset because subset will lead to unassigned objects, i.e., R will not know where the column vector name in the subset call comes from
  • Use <- rather than = to assign objects
  • Use seq_len(NROW(x)) or seq_along(x) rather than 1:NROW(x) or 1:length(x)
  • Importing functions from other packages in ss3sim functions

Branching

The main branch stores the current version of the code base and features are created in feature branches. Before merging in changes to main, Pull Requests should be opened on a feature branch, which will then be reviewed prior to rebasing and merging into the main branch.