return values in TableOne object explained. summary(obj$CatTable) in …

…example
kaz-yos · Feb 15, 2014 · a1e417d · a1e417d
1 parent 684220c
commit a1e417d
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 15 deletions.
diff --git a/R/CreateTableOne.R b/R/CreateTableOne.R
@@ -30,12 +30,10 @@
 ##' should suffice.
 ##' @param argsExact A named list of arguments passed to the function specified in testExact. The default is \code{list(workspace = 2*10^5)}, which specifies the memory space allocated for \code{\link{fisher.test}}.
 ##' @return An object of class \code{TableOne}, which really is a list of three objects. 
-##' \itemize{
-##'   \item{TableOne}{a categorical-continuous mixture data formatted and printed by the \code{\link{print.TableOne}} method}
-##'   \item{ContTable}{an object of class \code{ContTable}, containing continuous variables only}
-##'   \item{CatTable}{ an object of class \code{CattTable}, containing categorical variables only}
-##' }
-##' The second and third objects can be then be examined with the \code{print} and \code{summary} method, for example, \code{summary(object$CatTable)} to examine the categorical variables in detail.
+##' @return \item{TableOne}{a categorical-continuous mixture data formatted and printed by the \code{\link{print.TableOne}} method}
+##' @return \item{ContTable}{an object of class \code{ContTable}, containing continuous variables only}
+##' @return \item{CatTable}{ an object of class \code{CatTable}, containing categorical variables only}
+##' @return The second and third objects can be then be examined with the \code{print} and \code{summary} method, for example, \code{summary(object$CatTable)} to examine the categorical variables in detail.
 ##' 
 ##' @author Justin Bohn, Kazuki Yoshida
 ##' @seealso
@@ -80,9 +78,11 @@
 ##'
 ##' ## See the categorical part only using $ operator
 ##' tableOne$CatTable
+##' summary(tableOne$CatTable)
 ##'
 ##' ## See the continuous part only using $ operator
 ##' tableOne$ContTable
+##' summary(tableOne$ContTable)
 ##'
 ##' @export
 CreateTableOne <-

diff --git a/R/tableone-package.R b/R/tableone-package.R
@@ -61,8 +61,10 @@
 ##' 
 ##' ## See the categorical part only using $ operator
 ##' tableOne$CatTable
+##' summary(tableOne$CatTable)
 ##'
 ##' ## See the continuous part only using $ operator
 ##' tableOne$ContTable
+##' summary(tableOne$ContTable)
 ##'
 NULL
diff --git a/man/CreateTableOne.Rd b/man/CreateTableOne.Rd
@@ -70,16 +70,22 @@ CreateTableOne(vars, strata, data, test = TRUE, testApprox = chisq.test,
 }
 \value{
 An object of class \code{TableOne}, which really is a list
-of three objects. \itemize{ \item{TableOne}{a
-categorical-continuous mixture data formatted and printed
-by the \code{\link{print.TableOne}} method}
+of three objects.
+
+\item{TableOne}{a categorical-continuous mixture data
+formatted and printed by the \code{\link{print.TableOne}}
+method}
+
 \item{ContTable}{an object of class \code{ContTable},
-containing continuous variables only} \item{CatTable}{ an
-object of class \code{CattTable}, containing categorical
-variables only} } The second and third objects can be then
-be examined with the \code{print} and \code{summary}
-method, for example, \code{summary(object$CatTable)} to
-examine the categorical variables in detail.
+containing continuous variables only}
+
+\item{CatTable}{ an object of class \code{CatTable},
+containing categorical variables only}
+
+The second and third objects can be then be examined with
+the \code{print} and \code{summary} method, for example,
+\code{summary(object$CatTable)} to examine the categorical
+variables in detail.
 }
 \description{
 Create an object summarizing categorical variables
@@ -126,9 +132,11 @@ summary(tableOne)
 
 ## See the categorical part only using $ operator
 tableOne$CatTable
+summary(tableOne$CatTable)
 
 ## See the continuous part only using $ operator
 tableOne$ContTable
+summary(tableOne$ContTable)
 }
 \author{
 Justin Bohn, Kazuki Yoshida

diff --git a/man/tableone-package.Rd b/man/tableone-package.Rd
@@ -65,9 +65,11 @@ summary(tableOne)
 
 ## See the categorical part only using $ operator
 tableOne$CatTable
+summary(tableOne$CatTable)
 
 ## See the continuous part only using $ operator
 tableOne$ContTable
+summary(tableOne$ContTable)
 }
 \author{
 Kazuki Yoshida, Justin Bohn