more doc for 'logit_scaled'

paul-buerkner · Feb 1, 2017 · e7e8747 · e7e8747
1 parent 9413817
commit e7e8747
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/R/misc.R b/R/misc.R
@@ -375,6 +375,10 @@ expp1 <- function(x) {
 #' Computes \code{logit((x - lb) / (ub - lb))}
 #' 
 #' @param x A numeric or complex vector.
+#' @param lb Lower bound defaulting to \code{0}.
+#' @param ub Upper bound defaulting to \code{1}.
+#' 
+#' @return A numeric or complex vector.
 #' 
 #' @export
 logit_scaled <- function(x, lb = 0, ub = 1) {
@@ -386,8 +390,10 @@ logit_scaled <- function(x, lb = 0, ub = 1) {
 #' Computes \code{inv_logit(x) * (ub - lb) + lb}
 #' 
 #' @param x A numeric or complex vector.
+#' @param lb Lower bound defaulting to \code{0}.
+#' @param ub Upper bound defaulting to \code{1}.
 #' 
-#' @return A vector of values between \code{lb} and \code{ub}.
+#' @return A numeric or complex vector between \code{lb} and \code{ub}.
 #' 
 #' @export
 inv_logit_scaled <- function(x, lb = 0, ub = 1) {

diff --git a/man/inv_logit_scaled.Rd b/man/inv_logit_scaled.Rd
diff --git a/man/logit_scaled.Rd b/man/logit_scaled.Rd