diff --git a/R/gain.R b/R/gain.R index c77e21c..df0af99 100644 --- a/R/gain.R +++ b/R/gain.R @@ -6,6 +6,8 @@ #' #' The argument \code{gamma} controls the definition of genetic merit. (See notation in the journal publication.) The default is NULL, which implies breeding values. For purely additive values, use gamma = 0. For total genotypic value, use gamma = 1. #' +#' Note that this function assumes a selection index of BLUPs, not phenotypes. +#' #' @param input either object of \code{\link{class_prep}} or quad.mat returned by this function #' @param merit named vector of merit coefficients, in genetic standard deviation units #' @param desired named vector of desired gains, in genetic standard deviation units diff --git a/man/Stage1.Rd b/man/Stage1.Rd index bc4ddee..f8750b4 100644 --- a/man/Stage1.Rd +++ b/man/Stage1.Rd @@ -11,7 +11,8 @@ Stage1( solver = "asreml", spline = NULL, silent = TRUE, - workspace = c("500mb", "500mb") + workspace = c("500mb", "500mb"), + max.iter = 30 ) } \arguments{ @@ -28,6 +29,8 @@ Stage1( \item{silent}{TRUE/FALSE, whether to suppress REML output} \item{workspace}{memory limits for ASRreml-R} + +\item{max.iter}{maximum number of iterations for ASRreml-R} } \value{ List containing diff --git a/man/gain.Rd b/man/gain.Rd index f06acb7..87b263a 100644 --- a/man/gain.Rd +++ b/man/gain.Rd @@ -45,4 +45,6 @@ Genetic gain calculations Either \code{merit} or \code{desired} can be used, not both. The former specifies the relative contribution of each trait to genetic merit, while the latter specifies the relative desired gain in genetic standard deviation units. All traits must be specified. Optional argument \code{restricted} is a data frame with columns "trait" and "sign", where the options for sign are "=",">","<", representing equal to zero, non-negative, and non-positive. When \code{desired} is used, the \code{restricted} argument is ignored. The argument \code{gamma} controls the definition of genetic merit. (See notation in the journal publication.) The default is NULL, which implies breeding values. For purely additive values, use gamma = 0. For total genotypic value, use gamma = 1. + +Note that this function assumes a selection index of BLUPs, not phenotypes. }