usage section dropped (roxygen automates this)

kaz-yos · Feb 9, 2014 · 53619f8 · 53619f8
1 parent 2779f08
commit 53619f8
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 22 deletions.
diff --git a/R/CreateCatTable.R b/R/CreateCatTable.R
@@ -39,7 +39,7 @@
 ##' @seealso print.CatTable, summary.CatTable, CreateContTable,
 ##' print.ContTable, summary.ContTable
 ## @references
-##' @keywords ~kwd1 ~kwd2
+## @keywords ~kwd1 ~kwd2
 ##' @examples
 ##' 
 ##' ## Load

diff --git a/R/CreateContTable.R b/R/CreateContTable.R
@@ -5,10 +5,10 @@
 ##' object gives a table that is easy to use in medical research papers.
 ##' 
 ##' 
-##' @usage CreateContTable(vars, strata, data, func.names = c("n", "miss",
-##' "mean", "sd", "median", "p25", "p75", "min", "max", "skew", "kurt"),
-##' func.additional, test = TRUE, testNormal = oneway.test, testNonNormal =
-##' kruskal.test)
+## @usage CreateContTable(vars, strata, data, func.names = c("n", "miss",
+## "mean", "sd", "median", "p25", "p75", "min", "max", "skew", "kurt"),
+## func.additional, test = TRUE, testNormal = oneway.test, testNonNormal =
+## kruskal.test)
 ##' @param vars Variable(s) to be summarized given as a character vector.
 ##' @param strata Stratifying (grouping) variable name(s) given as a character
 ##' vector. If omitted, the overall results are returned.
@@ -49,7 +49,7 @@
 ##' @seealso print.ContTable, summary.ContTable, CreateCatTable,
 ##' print.CatTable, summary.CatTable
 ## @references
-##' @keywords ~kwd1 ~kwd2
+## @keywords ~kwd1 ~kwd2
 ##' @examples
 ##' 
 ##' ## Load

diff --git a/R/ShowRegTable.R b/R/ShowRegTable.R
@@ -4,8 +4,8 @@
 ##' usually the form used in medical research papers.
 ##' 
 ##' 
-##' @usage ShowRegTable(model, exp = TRUE, digits = 2, pDigits = 3, quote =
-##' FALSE)
+## @usage ShowRegTable(model, exp = TRUE, digits = 2, pDigits = 3, quote =
+## FALSE)
 ##' @param model Regression model result objects that have the summary and
 ##' confint methods.
 ##' @param exp TRUE by default. You need to specify exp = FALSE if your model
@@ -25,7 +25,7 @@
 ##' @seealso CreateContTable, print.ContTable, summary.ContTable,
 ##' CreateCatTable, print.CatTable, summary.CatTable
 ## @references
-##' @keywords ~kwd1 ~kwd2
+## @keywords ~kwd1 ~kwd2
 ##' @examples
 ##' 
 ##' ## Load

diff --git a/R/print.CatTable.R b/R/print.CatTable.R
@@ -4,10 +4,10 @@
 ##' CreateCatTable function.
 ##' 
 ##' 
-##' @usage ## S3 method for class 'CatTable' print.CatTable(CatTable, missing =
-##' FALSE, format = c("fp", "f", "p", "pf")[1], digits = 1, exact = NULL, quote
-##' = FALSE, test = TRUE, pDigits = 3, showAllLevels = FALSE, explain = TRUE,
-##' CrossTable = FALSE)
+## @usage ## S3 method for class 'CatTable' print.CatTable(CatTable, missing =
+## FALSE, format = c("fp", "f", "p", "pf")[1], digits = 1, exact = NULL, quote
+## = FALSE, test = TRUE, pDigits = 3, showAllLevels = FALSE, explain = TRUE,
+## CrossTable = FALSE)
 ##' @param CatTable The result of a call to the ‘CreateCatTable’ function.
 ##' @param missing Whether to show missing data information (not implemented
 ##' yet, placeholder)
@@ -46,7 +46,7 @@
 ##' @seealso CreateCatTable, summary.CatTable, CreateContTable,
 ##' print.ContTable, summary.ContTable
 ## @references
-##' @keywords ~kwd1 ~kwd2
+## @keywords ~kwd1 ~kwd2
 ##' @examples
 ##' 
 ##' ## Load

diff --git a/R/print.ContTable.R b/R/print.ContTable.R
@@ -4,8 +4,8 @@
 ##' CreateContTable function.
 ##' 
 ##' 
-##' @usage print.ContTable(ContTable, missing = FALSE, digits = 2, nonnormal =
-##' NULL, quote = FALSE, test = TRUE, pDigits = 3, explain = TRUE)
+## @usage print.ContTable(ContTable, missing = FALSE, digits = 2, nonnormal =
+## NULL, quote = FALSE, test = TRUE, pDigits = 3, explain = TRUE)
 ##' @param ContTable The result of a call to the ‘CreateContTable’ function.
 ##' @param missing Whether to show missing data information (not implemented
 ##' yet, placeholder)
@@ -35,7 +35,7 @@
 ##' @seealso CreateContTable, summary.ContTable, CreateCatTable,
 ##' print.CatTable, summary.CatTable
 ## @references
-##' @keywords ~kwd1 ~kwd2
+## @keywords ~kwd1 ~kwd2
 ##' @examples
 ##' 
 ##' ## Load

diff --git a/R/summary.CatTable.R b/R/summary.CatTable.R
@@ -6,7 +6,7 @@
 ##' (fisher.test by default).
 ##'
 ##'
-##' @usage summary.CatTable(CatTable, digits = 1)
+## @usage summary.CatTable(CatTable, digits = 1)
 ##' @param CatTable An object that has the ‘CatTable’ class to be shown.
 ##' @param digits Number of digits to print.
 ##' @return It will print the results.
@@ -22,7 +22,7 @@
 ##' @seealso CreateCatTable, print.CatTable, CreateContTable, print.ContTable,
 ##' summary.ContTable
 ## @references
-##' @keywords ~kwd1 ~kwd2
+## @keywords ~kwd1 ~kwd2
 ##' @examples
 ##'
 ##' ## Load

diff --git a/R/summary.ContTable.R b/R/summary.ContTable.R
@@ -6,7 +6,7 @@
 ##' test (kruskal.test by default).
 ##'
 ##'
-##' @usage summary.ContTable(ContTable, digits = 2)
+## @usage summary.ContTable(ContTable, digits = 2)
 ##' @param ContTable An object that has the ‘ContTable’ class to be shown.
 ##' @param digits Number of digits to print.
 ##' @return It will print the results.
@@ -22,7 +22,7 @@
 ##' @seealso CreateContTable, print.ContTable, CreateCatTable, print.CatTable,
 ##' summary.CatTable
 ## @references
-##' @keywords ~kwd1 ~kwd2
+## @keywords ~kwd1 ~kwd2
 ##' @examples
 ##'
 ##' ## Load

diff --git a/R/tableone-package.R b/R/tableone-package.R
@@ -29,7 +29,7 @@
 ##' Maintainer: Kazuki Yoshida <kazukiyoshida@@mail.harvard.edu>
 ## @seealso
 ## @references
-##' @keywords package
+## @keywords package
 ##' @examples
 ##' 
 ##' ## Load