Browse Source

Update documentation

tags/0.1.6
Maxime Wack 5 years ago
parent
commit
670378bd25
8 changed files with 25 additions and 802 deletions
  1. +1
    -1
      DESCRIPTION
  2. +0
    -780
      inst/doc/desctable.html
  3. +2
    -2
      man/chisq.test.Rd
  4. +11
    -10
      man/datatable.Rd
  5. +4
    -3
      man/desctable.Rd
  6. +3
    -3
      man/fisher.test.Rd
  7. +1
    -1
      man/group_by.Rd
  8. +3
    -2
      man/pander.desctable.Rd

+ 1
- 1
DESCRIPTION View File

@@ -23,5 +23,5 @@ Suggests:
knitr,
rmarkdown,
survival
RoxygenNote: 6.0.1
RoxygenNote: 6.1.1
VignetteBuilder: knitr

+ 0
- 780
inst/doc/desctable.html
File diff suppressed because it is too large
View File


+ 2
- 2
man/chisq.test.Rd View File

@@ -16,8 +16,8 @@ chisq.test(x, y, correct, p, rescale.p, simulate.p.value, B)
simulate.p.value = FALSE, B = 2000)

\method{chisq.test}{formula}(x, y = NULL, correct = T,
p = rep(1/length(x), length(x)), rescale.p = F, simulate.p.value = F,
B = 2000)
p = rep(1/length(x), length(x)), rescale.p = F,
simulate.p.value = F, B = 2000)
}
\arguments{
\item{x}{a numeric vector, or matrix, or formula of the form \code{lhs ~ rhs} where \code{lhs} and \code{rhs} are factors. \code{x} and \code{y} can also both be factors.}


+ 11
- 10
man/datatable.Rd View File

@@ -9,9 +9,9 @@
datatable(data, ...)

\method{datatable}{default}(data, options = list(), class = "display",
callback = DT::JS("return table;"), caption = NULL, filter = c("none",
"bottom", "top"), escape = TRUE, style = "default", width = NULL,
height = NULL, elementId = NULL,
callback = DT::JS("return table;"), caption = NULL,
filter = c("none", "bottom", "top"), escape = TRUE,
style = "default", width = NULL, height = NULL, elementId = NULL,
fillContainer = getOption("DT.fillContainer", NULL),
autoHideNavigation = getOption("DT.autoHideNavigation", NULL),
selection = c("multiple", "single", "none"), extensions = list(),
@@ -20,14 +20,14 @@ datatable(data, ...)
\method{datatable}{desctable}(data, options = list(paging = F, info = F,
search = F, dom = "Brtip", fixedColumns = T, fixedHeader = T, buttons =
c("copy", "excel")), class = "display",
callback = DT::JS("return table;"), caption = NULL, filter = c("none",
"bottom", "top"), escape = FALSE, style = "default", width = NULL,
height = NULL, elementId = NULL,
callback = DT::JS("return table;"), caption = NULL,
filter = c("none", "bottom", "top"), escape = FALSE,
style = "default", width = NULL, height = NULL, elementId = NULL,
fillContainer = getOption("DT.fillContainer", NULL),
autoHideNavigation = getOption("DT.autoHideNavigation", NULL),
selection = c("multiple", "single", "none"), extensions = c("FixedHeader",
"FixedColumns", "Buttons"), plugins = NULL, rownames = F, digits = 2,
...)
selection = c("multiple", "single", "none"),
extensions = c("FixedHeader", "FixedColumns", "Buttons"),
plugins = NULL, rownames = F, digits = 2, ...)
}
\arguments{
\item{data}{a data object (either a matrix or a data frame)}
@@ -98,7 +98,8 @@ select cells}
extensions (\url{https://datatables.net/extensions/index})}

\item{plugins}{a character vector of the names of DataTables plug-ins
(\url{https://rstudio.github.io/DT/plugins.html})}
(\url{https://rstudio.github.io/DT/plugins.html}). Note that only those
plugins supported by the \code{DT} package can be used here.}

\item{rownames}{\code{TRUE} (show row names) or \code{FALSE} (hide row names)
or a character vector of row names; by default, the row names are displayed


+ 4
- 3
man/desctable.Rd View File

@@ -8,10 +8,11 @@
\usage{
desctable(data, stats, tests, labels)

\method{desctable}{default}(data, stats = stats_auto, tests, labels = NULL)

\method{desctable}{grouped_df}(data, stats = stats_auto, tests = tests_auto,
\method{desctable}{default}(data, stats = stats_auto, tests,
labels = NULL)

\method{desctable}{grouped_df}(data, stats = stats_auto,
tests = tests_auto, labels = NULL)
}
\arguments{
\item{data}{The dataframe to analyze}


+ 3
- 3
man/fisher.test.Rd View File

@@ -11,9 +11,9 @@ fisher.test(x, y, workspace, hybrid, control, or, alternative, conf.int,

\method{fisher.test}{default}(x, ...)

\method{fisher.test}{formula}(x, y = NULL, workspace = 2e+05, hybrid = F,
control = list(), or = 1, alternative = "two.sided", conf.int = T,
conf.level = 0.95, simulate.p.value = F, B = 2000)
\method{fisher.test}{formula}(x, y = NULL, workspace = 200000,
hybrid = F, control = list(), or = 1, alternative = "two.sided",
conf.int = T, conf.level = 0.95, simulate.p.value = F, B = 2000)
}
\arguments{
\item{x}{either a two-dimensional contingency table in matrix form, a factor object, or a formula of the form \code{lhs ~ rhs} where \code{lhs} and \code{rhs} are factors.}


+ 1
- 1
man/group_by.Rd View File

@@ -4,7 +4,7 @@
\alias{group_by}
\title{Group a tbl by one or more variables.}
\usage{
group_by(.data, ..., add = FALSE)
group_by(.data, ..., add = FALSE, .drop = FALSE)
}
\description{
Group a tbl by one or more variables.


+ 3
- 2
man/pander.desctable.Rd View File

@@ -4,8 +4,9 @@
\alias{pander.desctable}
\title{Pander method for desctable}
\usage{
pander.desctable(x = NULL, digits = 2, justify = "left", missing = "",
keep.line.breaks = T, split.tables = Inf, emphasize.rownames = F, ...)
pander.desctable(x = NULL, digits = 2, justify = "left",
missing = "", keep.line.breaks = T, split.tables = Inf,
emphasize.rownames = F, ...)
}
\arguments{
\item{x}{A desctable}


Loading…
Cancel
Save