Skip to content

Commit

Permalink
Fix documentation with inhertedParams
Browse files Browse the repository at this point in the history
  • Loading branch information
Schiano-NOAA committed Sep 27, 2024
1 parent 1641eba commit dd154b5
Show file tree
Hide file tree
Showing 12 changed files with 21 additions and 23 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
^\.Rproj\.user$
^\.github$
^LICENSE\.md$
^data-raw$
2 changes: 2 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ Imports:
utils
Remotes:
nmfs-fish-tools/nmfspalette
Depends:
R (>= 2.10)
2 changes: 1 addition & 1 deletion R/plot_biomass.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' Plot Total Biomass
#'
#' @inheritParamsplot_recruitment
#' @inheritParams plot_recruitment
#' @param show_warnings Option to suppress warnings
#' @param units units for biomass
#' @param scaled TRUE/FALSE; indicate whether the output values for biomass and recruitment are scaled
Expand Down
3 changes: 2 additions & 1 deletion R/plot_recruitment.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#' Plot Recruitment
#'
#' @inheritParams plot_recruitment
#' @param dat .csv file and path where the data is located of standard stock assessment output
#' @param model the model in which the output came from (standard, SS3, BAM, ect)
#' @param params Print/export the parameters of the stock recruitment function?
#' @param params_only Only export the stock recruitment function or both the parameters and the plot(s)?
#' @param units If units are not available in the output file, in metric tons,
Expand Down
1 change: 0 additions & 1 deletion R/table_indices.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#' Create Indices of Abundance Table
#'
#' @inheritParams plot_recruitment
#'
#' @return Create table of observed annual indices of abundance plus error
#' stratified by fleet.
#' @export
Expand Down
3 changes: 3 additions & 0 deletions data-raw/dat.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## code to prepare `dat` dataset goes here

usethis::use_data(dat, overwrite = TRUE)
Binary file added data/dat.rda
Binary file not shown.
7 changes: 2 additions & 5 deletions man/plot_landings.Rd

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

7 changes: 2 additions & 5 deletions man/plot_recruitment.Rd

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

7 changes: 2 additions & 5 deletions man/plot_spawning_biomass.Rd

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

4 changes: 4 additions & 0 deletions man/plot_total_biomass.Rd

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

7 changes: 2 additions & 5 deletions man/table_indices.Rd

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

0 comments on commit dd154b5

Please sign in to comment.