values in TableOne obj format experiment 1

kaz-yos · Feb 15, 2014 · 684220c · 684220c
1 parent 5180a47
commit 684220c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 13 deletions.
diff --git a/R/CreateTableOne.R b/R/CreateTableOne.R
@@ -29,7 +29,14 @@
 ##' memory limitation. In this situation, the large sample approximation based
 ##' 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. The first object named \code{object$TableOne} is the categorical-continuous mixture table formatted and printed by the \code{\link{print.TableOne}} method. The second object named \code{object$ContTable} is the table object containing continuous variables only. The third object named \code{object$CatTable} is the table object 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 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.
+##' 
 ##' @author Justin Bohn, Kazuki Yoshida
 ##' @seealso
 ##' \code{\link{CreateTableOne}}, \code{\link{print.TableOne}}, \code{\link{summary.TableOne}},

diff --git a/man/CreateTableOne.Rd b/man/CreateTableOne.Rd
@@ -70,18 +70,16 @@ CreateTableOne(vars, strata, data, test = TRUE, testApprox = chisq.test,
 }
 \value{
 An object of class \code{TableOne}, which really is a list
-of three objects. The first object named
-\code{object$TableOne} is the categorical-continuous
-mixture table formatted and printed by the
-\code{\link{print.TableOne}} method. The second object
-named \code{object$ContTable} is the table object
-containing continuous variables only. The third object
-named \code{object$CatTable} is the table object 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.
+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.
 }
 \description{
 Create an object summarizing categorical variables