Merge pull request #21 from arni-magnusson/master

Add placeholder help pages for classes
PacificCommunity · Nov 20, 2022 · 9a7a814 · 9a7a814
2 parents beb5a65 + 60a2d2a
commit 9a7a814
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 6 deletions.
diff --git a/R/AllClasses.R b/R/AllClasses.R
@@ -703,6 +703,9 @@ validMFCLTagProj <- function(object){
   #Everything is fine
   return(TRUE)
 }
+
+#' An S4 class : Undocumented.
+
 setClass("MFCLTagProj",
          representation(
            release_groups_proj = "numeric",
@@ -745,6 +748,9 @@ validMFCLTag <- function(object){
   #Everything is fine
   return(TRUE)
 }
+
+#' An S4 class : Undocumented.
+
 setClass("MFCLTag",
          representation(
            "MFCLTagProj",
@@ -885,6 +891,9 @@ validMFCLprojControl <- function(object){
   #Everything is fine
   return(TRUE)
 }
+
+#' An S4 class : Undocumented.
+
 setClass("MFCLprojControl",
          representation(
            nyears              ="numeric",
@@ -1057,6 +1066,9 @@ validMFCLPseudo <- function(object){
   #Everything is fine
   return(TRUE)
 }
+
+#' An S4 class : Undocumented.
+
 setClass("MFCLPseudo",
          representation(
            "MFCLLenFreq",

diff --git a/R/generate.r b/R/generate.r
@@ -65,7 +65,7 @@ generate.ESS<- function(x, ctrl, projdat2, sc_df){
 #' @param ... Additional arguments (currently unused).
 #' @return An object of the same type as the \code{x} argument, expanded and hopefully useable for running projections.
 #' @export
-#' @seealso \code{\link{MFCLprojContrl}} \code{\link{MFCLFrq}} \code{\link{MFCLPar}}
+#' @seealso \code{\link{MFCLprojControl}} \code{\link{MFCLFrq}} \code{\link{MFCLPar}}
 #' @examples
 #' \dontrun{
 #' # Expanding an MFCLFrq, e.g. that was used from in an assessment

diff --git a/R/read.MFCLPseudo.r b/R/read.MFCLPseudo.r
@@ -85,7 +85,7 @@ read.MFCLPseudoEffort <- function(effort="effort_sim", projfrq=projfrq, ctrl="mi
 #'
 #' @export
 #'
-#' @seealso \code{\link{MFCLprojContrl}} \code{\link{MFCLFrq}} \code{\link{MFCLPar}}
+#' @seealso \code{\link{MFCLprojControl}} \code{\link{MFCLFrq}} \code{\link{MFCLPar}}
 #'
 #' @examples
 #' \dontrun{
@@ -148,7 +148,7 @@ read.MFCLPseudoCatchEffort <- function(catch="catch_sim", effort="effort_sim", p
 #'
 #' @export
 #'
-#' @seealso \code{\link{MFCLprojContrl}} \code{\link{MFCLFrq}} \code{\link{MFCLPar}}
+#' @seealso \code{\link{MFCLprojControl}} \code{\link{MFCLFrq}} \code{\link{MFCLPar}}
 #'
 #' @examples
 #' \dontrun{

diff --git a/man/MFCLPseudo-class.Rd b/man/MFCLPseudo-class.Rd
diff --git a/man/MFCLTag-class.Rd b/man/MFCLTag-class.Rd
diff --git a/man/MFCLTagProj-class.Rd b/man/MFCLTagProj-class.Rd
diff --git a/man/MFCLprojControl-class.Rd b/man/MFCLprojControl-class.Rd
diff --git a/man/generate.Rd b/man/generate.Rd
diff --git a/man/read.MFCLPseudoCatchEffort.Rd b/man/read.MFCLPseudoCatchEffort.Rd
diff --git a/man/read.MFCLPseudoSizeComp.Rd b/man/read.MFCLPseudoSizeComp.Rd