From e7e874734f81580d3ed2f87030c9382e2b669282 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Paul-Christian=20B=C3=BCrkner?= <paul.buerkner@gmail.com>
Date: Wed, 1 Feb 2017 11:04:35 +0100
Subject: [PATCH] more doc for 'logit_scaled'

---
 R/misc.R                | 8 +++++++-
 man/inv_logit_scaled.Rd | 6 +++++-
 man/logit_scaled.Rd     | 7 +++++++
 3 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/R/misc.R b/R/misc.R
index e4d0cb4ea..52e37ecd0 100644
--- 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
index 872b5ffec..a0110e424 100644
--- a/man/inv_logit_scaled.Rd
+++ b/man/inv_logit_scaled.Rd
@@ -8,9 +8,13 @@ inv_logit_scaled(x, lb = 0, ub = 1)
 }
 \arguments{
 \item{x}{A numeric or complex vector.}
+
+\item{lb}{Lower bound defaulting to \code{0}.}
+
+\item{ub}{Upper bound defaulting to \code{1}.}
 }
 \value{
-A vector of values between \code{lb} and \code{ub}.
+A numeric or complex vector between \code{lb} and \code{ub}.
 }
 \description{
 Computes \code{inv_logit(x) * (ub - lb) + lb}
diff --git a/man/logit_scaled.Rd b/man/logit_scaled.Rd
index 373a6c4a0..ac9dceafe 100644
--- a/man/logit_scaled.Rd
+++ b/man/logit_scaled.Rd
@@ -8,6 +8,13 @@ logit_scaled(x, lb = 0, ub = 1)
 }
 \arguments{
 \item{x}{A numeric or complex vector.}
+
+\item{lb}{Lower bound defaulting to \code{0}.}
+
+\item{ub}{Upper bound defaulting to \code{1}.}
+}
+\value{
+A numeric or complex vector.
 }
 \description{
 Computes \code{logit((x - lb) / (ub - lb))}