Updating documentation for package

nmfs-ost · Jul 31, 2024 · 0048b37 · 0048b37
1 parent 9787671
commit 0048b37
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 10 deletions.
diff --git a/R/plot_recruitment.R b/R/plot_recruitment.R
@@ -14,7 +14,7 @@
 #' reference line, stock recruitment curve, and other related figures.
 #' @export
 #'
-#' @examples
+#' @examples plot_recruitment(dat = dat, model = "BAM")
 plot_recruitment <- function(dat,
                              model,
                              params = FALSE,

diff --git a/R/table_indices.R b/R/table_indices.R
@@ -1,3 +1,13 @@
+#' Create Indices of Abundance Table
+#'
+#' @template dat
+#' @template model
+#'
+#' @return Create table of observed annual indices of abundance plus error
+#' stratified by fleet.
+#' @export
+#'
+#' @examples table_indices(dat = dat, model = "BAM")
 table_indices <- function(dat,
                           model){
   if(model == "SS3"){

diff --git a/man/plot_recruitment.Rd b/man/plot_recruitment.Rd
diff --git a/man/plot_spawning_biomass.Rd b/man/plot_spawning_biomass.Rd
diff --git a/man/table_indices.Rd b/man/table_indices.Rd