Final touches

R/control.R

@@ -67,6 +67,10 @@
 #' attributes.
 #'
 #' @section Constructor:
+#' A construction method exists for this class that can take named arguments for
+#' any of its slots. All slots are then created to match the requirements of the
+#' class validity.
+#'
 #' @author Laurence Kell & Philippe Grosjean
 #' @seealso \link{FLComp}
 #' @keywords classes

R/data.R

@@ -10,7 +10,9 @@
 #' previous stock estimates.} \item{*.xsa.control}{The FLXSA.control object for
 #' the reference run.} \item{*.xsa.ref}{The FLXSA object obtained from the
 #' reference run.} }
-#' 
+#'
+#' @name data
+#' @rdname data
 #' @aliases cod4 cod4.indices cod4.stock cod4.f.ref cod4.n.ref her4
 #' her4.indices her4.stock her4.f.ref her4.n.ref ple7a ple7a.indices
 #' ple7a.stock ple7a.f.ref ple7a.n.ref

R/flxsa.R

@@ -32,9 +32,6 @@
 #' regression analysis of multiple recruit index series. ICES J. Mar. Sci. In
 #' Prep.
 #' @keywords classes
-#' @examples
-#' 
-#' 
 
 setClass("FLXSA",
   contains='FLAssess',
@@ -150,10 +147,11 @@ setValidity("FLXSA", function(object) {
 #' Prep.
 #' @keywords classes
 #' @examples
+#'
+#' data(ple4)
+#' data(ple4.indices)
 #' 
-#' 
-#' #TO DO...
-#' 
+#' res <- FLXSA(ple4, ple4.indices)
 #' 
 
 setGeneric("FLXSA", function(stock, indices, ...)
@@ -542,7 +540,6 @@ setMethod("assess", signature(control="FLXSA.control"),
 #' xsa <- FLXSA.control()
 #' is.FLXSA.control(xsa)
 #' 
-#' @export is.FLXSA
 is.FLXSA <- function(x)
 	return(inherits(x, "FLXSA"))
 # }}}