Update documentation

DESCRIPTION

@@ -25,5 +25,5 @@ Suggests:
     rmarkdown,
     purrr,
     survival
-RoxygenNote: 7.0.2
+RoxygenNote: 7.1.1
 VignetteBuilder: knitr

man/datatable.Rd

@@ -30,8 +30,8 @@ datatable(data, ...)
 
 \method{datatable}{desctable}(
   data,
-  options = list(paging = F, info = F, search = list(), dom = "Brtip", fixedColumns = T,
-    fixedHeader = T, buttons = c("copy", "excel")),
+  options = list(paging = F, info = F, search = list(), dom = "Brtip", fixedColumns =
+    T, fixedHeader = T, buttons = c("copy", "excel")),
   class = "display",
   callback = DT::JS("return table;"),
   caption = NULL,
@@ -115,11 +115,12 @@ when the number of total records is less than the page size.}
 \item{selection}{the row/column selection mode (single or multiple selection
 or disable selection) when a table widget is rendered in a Shiny app;
 alternatively, you can use a list of the form \code{list(mode = 'multiple',
-selected = c(1, 3, 8), target = 'row')} to pre-select rows; the element
+selected = c(1, 3, 8), target = 'row', selectable = c(-2, -3))} to
+pre-select rows and control the selectable range; the element
 \code{target} in the list can be \code{'column'} to enable column
 selection, or \code{'row+column'} to make it possible to select both rows
 and columns (click on the footer to select columns), or \code{'cell'} to
-select cells}
+select cells. See details section for more info.}
 
 \item{extensions}{a character vector of the names of the DataTables
 extensions (\url{https://datatables.net/extensions/index})}

man/insert.Rd

@@ -7,9 +7,9 @@
 insert(x, y, position)
 }
 \arguments{
-\item{x}{A vector}
+\item{x}{A vector to be inserted into}
 
-\item{y}{A vector or list of vectors}
+\item{y}{A vector or list of vectors to insert into x}
 
 \item{position}{The position / vector of positions to insert vector(s) y in vector x}
 }
@@ -17,5 +17,6 @@ insert(x, y, position)
 The combined vector
 }
 \description{
-Insert a vector y inside another vector x at position
+The vectors in the y list will be inserted
+at positions respectively *after* the x[position] element of x
 }

man/reexports.Rd

@@ -12,6 +12,6 @@ These objects are imported from other packages. Follow the links
 below to see their documentation.
 
 \describe{
-  \item{dplyr}{\code{\link[dplyr]{\%>\%}}, \code{\link[dplyr]{group_by}}}
+  \item{dplyr}{\code{\link[dplyr:reexports]{\%>\%}}, \code{\link[dplyr]{group_by}}}
 }}
 

man/set_desctable_class.Rd

@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{set_desctable_class}
+\alias{set_desctable_class}
+\title{Set the "desctable" class to the passed object}
+\usage{
+set_desctable_class(x)
+}
+\arguments{
+\item{x}{Object to set the "desctable" class to}
+}
+\value{
+The object with the class "desctable"
+}
+\description{
+Set the "desctable" class to the passed object
+}

man/statColumn.Rd

@@ -15,5 +15,10 @@ statColumn(stat, data)
 A vector for one statistic column
 }
 \description{
-Generate one statistic for all variables
+Use one stat function (made safe using statify) on all the data
+to produce a single statistics column.
+}
+\details{
+The result is either a numeric vector, or a character vector if
+the content of the column is not made entirely of numbers.
 }

man/statTable.Rd

@@ -15,5 +15,7 @@ statTable(data, stats)
 A dataframe of all statistics for all variables
 }
 \description{
-Generate the table of all statistics for all variables
+If stats is a list of functions, use them.
+If it is a single function, use it with the entire data as
+its argument to produce a list of statistical functions to use.
 }