Add additional examples

mclements · mclements · commit 65c0c330ec7a · 2020-07-27T22:22:30.000+02:00
diff --git a/R/asciiAnova.r b/R/asciiAnova.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' local({x <- 1:10; y <- rnorm(length(x),1+x); ascii(anova(lm(y~x)))})
+##' options(op)
 ##' @method ascii anova
 ascii.anova <- function (x, include.rownames = TRUE, include.colnames = TRUE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = TRUE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
   x <- as.data.frame(x, check.names = FALSE)
diff --git a/R/asciiDataFrame.r b/R/asciiDataFrame.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(data.frame(a = 1:3, b = 2), include.rownames = FALSE, digits = 0)
+##' options(op)
 ##' @method ascii data.frame
 ascii.data.frame <- function(x, include.rownames = TRUE, include.colnames = TRUE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = TRUE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...) {
 
diff --git a/R/asciiGlm.r b/R/asciiGlm.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' local({x <- 1:10; y <- rnorm(length(x), 1+x); ascii(glm(y~x)) })
+##' options(op)
 ##' @method ascii glm
 ascii.glm <- function (x, include.rownames = TRUE, include.colnames = TRUE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = TRUE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
   x <- as.data.frame(summary(x)$coef)
@@ -20,6 +24,10 @@ ascii.glm <- function (x, include.rownames = TRUE, include.colnames = TRUE, rown
 }
 
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' local({x <- 1:10; y <- rnorm(length(x), 1+x); ascii(summary(glm(y~x))) })
+##' options(op)
 ##' @method ascii summary.glm
 ascii.summary.glm <- function (x, include.rownames = TRUE, include.colnames = TRUE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = TRUE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
   x <- as.data.frame(x$coef)
diff --git a/R/asciiHtest.r b/R/asciiHtest.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' local({x <- rnorm(100); ascii(t.test(x))})
+##' options(op)
 ##' @method ascii htest
 ascii.htest <- function(x, include.rownames = TRUE, include.colnames = TRUE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = TRUE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
   if (x$method == "Fisher's Exact Test for Count Data") {
diff --git a/R/asciiList.r b/R/asciiList.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(list(a=1,b=2), list.type="label")
+##' options(op)
 ##' @method ascii list
 ascii.list <- function(x, caption = NULL, caption.level = NULL, list.type = "bullet", ...) {
     obj <- asciiList$new(x = x, caption = caption, caption.level = caption.level, list.type = list.type)
@@ -14,6 +18,10 @@ ascii.simple.list <- function(x, caption = NULL, caption.level = NULL, list.type
 }
 
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(sessionInfo())
+##' options(op)
 ##' @method ascii packageDescription
 ascii.packageDescription <- function(x, caption = NULL, caption.level = NULL, list.type = "label", ...) {
   x <- unclass(x)
diff --git a/R/asciiLm.r b/R/asciiLm.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' local({x <- 1:10; y <- rnorm(length(x), 1+x); ascii(lm(y~x)) })
+##' options(op)
 ##' @method ascii lm
 ascii.lm <- function (x, include.rownames = TRUE, include.colnames = TRUE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = TRUE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
     x <- as.data.frame(summary(x)$coef)
@@ -20,6 +24,10 @@ ascii.lm <- function (x, include.rownames = TRUE, include.colnames = TRUE, rowna
 }
 
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' local({x <- 1:10; y <- rnorm(length(x), 1+x); ascii(summary(lm(y~x))) })
+##' options(op)
 ##' @method ascii summary.lm
 ascii.summary.lm <- function (x, include.rownames = TRUE, include.colnames = TRUE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = TRUE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
     x <- as.data.frame(x$coef)
diff --git a/R/asciiMatrix.r b/R/asciiMatrix.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(matrix(1:4,2,2,FALSE,list(1:2,c("A","B"))), TRUE, TRUE, digits=0)
+##' options(op)
 ##' @method ascii matrix
 ascii.matrix <- function (x, include.rownames = FALSE, include.colnames = FALSE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = FALSE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
 
diff --git a/R/asciiTable.r b/R/asciiTable.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(table(rbinom(100,5,.3)), digits=0)
+##' options(op)
 ##' @method ascii table
 ascii.table <- function (x, include.rownames = TRUE, include.colnames = TRUE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = TRUE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
 
diff --git a/R/asciiVector.r b/R/asciiVector.r
@@ -1,4 +1,8 @@
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(c(a=1L,b=2L),FALSE,TRUE,digits=0)
+##' options(op)
 ##' @method ascii integer
 ascii.integer <- function (x, include.rownames = FALSE, include.colnames = FALSE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = FALSE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
     obj <- asciiTable$new(x = x, include.rownames = include.rownames,
@@ -19,6 +23,10 @@ ascii.integer <- function (x, include.rownames = FALSE, include.colnames = FALSE
 }
 
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(seq(0,1,length=11),digits=1)
+##' options(op)
 ##' @method ascii numeric
 ascii.numeric <- function (x, include.rownames = FALSE, include.colnames = FALSE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = FALSE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
     obj <- asciiTable$new(x = x, include.rownames = include.rownames,
@@ -39,6 +47,10 @@ ascii.numeric <- function (x, include.rownames = FALSE, include.colnames = FALSE
 }
 
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(c(a="A",b="B"),FALSE,TRUE,header=TRUE)
+##' options(op)
 ##' @method ascii character
 ascii.character <- function (x, include.rownames = FALSE, include.colnames = FALSE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = FALSE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
     obj <- asciiTable$new(x = x, include.rownames = include.rownames,
@@ -59,6 +71,10 @@ ascii.character <- function (x, include.rownames = FALSE, include.colnames = FAL
 }
 
 ##' @export
+##' @examples
+##' op <- options(asciiType = "org")
+##' ascii(factor(c("A","B")),FALSE)
+##' options(op)
 ##' @method ascii factor
 ascii.factor <- function (x, include.rownames = FALSE, include.colnames = FALSE, rownames = NULL, colnames = NULL, format = "f", digits = 2, decimal.mark = ".", na.print = "", caption = NULL, caption.level = NULL, width = 0, frame = NULL, grid = NULL, valign = NULL, header = FALSE, footer = FALSE, align = NULL, col.width = 1, style = NULL, tgroup = NULL, n.tgroup = NULL, talign = "c", tvalign = "middle", tstyle = "h", bgroup = NULL, n.bgroup = NULL, balign = "c", bvalign = "middle", bstyle = "h", lgroup = NULL, n.lgroup = NULL, lalign = "c", lvalign = "middle", lstyle = "h", rgroup = NULL, n.rgroup = NULL, ralign = "c", rvalign = "middle", rstyle = "h", ...){
     obj <- asciiTable$new(x = x, include.rownames = include.rownames,
diff --git a/R/export.r b/R/export.r
@@ -546,7 +546,7 @@ print.fig <- function(x, backend = getOption("asciiBackend"), ...) {
 ##' @author David Hajage
 ##' @examples
 ##' \dontrun{
-##' old <- options(asciiType = "asciidoc")
+##' op <- options(asciiType = "asciidoc")
 ##' createreport(head(esoph))
 ##'
 ##' r <- Report$new(author = "David Hajage", email = "dhajage at gmail dot com")
@@ -569,7 +569,7 @@ print.fig <- function(x, backend = getOption("asciiBackend"), ...) {
 ##' r$create()
 ##'
 ##' r$create(backend = "markdown2pdf", format = "pdf")
-##' options(old)
+##' options(op)
 ##' }
 createreport <- function(..., list = NULL, file = NULL, format = NULL, open = TRUE, backend = getOption("asciiBackend"), encoding = NULL, options = NULL, cygwin = FALSE, title = NULL, author = NULL, email = NULL, date = NULL) {
 
