update documentation

jendelman · Mar 15, 2024 · 088069a · 088069a
1 parent 74178ab
commit 088069a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git 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
diff --git a/man/gain.Rd b/man/gain.Rd