Skip to content

Commit 3f4649f

Browse files
MichaelChiricoMichaelChirico
authored
style change: mention default up-front
1 parent eaa2b67 commit 3f4649f

File tree

1 file changed

+59
-87
lines changed

1 file changed

+59
-87
lines changed

‎man/data.table-options.Rd‎

Lines changed: 59 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -22,119 +22,91 @@
2222
}
2323
2424
\section{Printing Options}{
25-
See \code{\link{print.data.table}} for a full description of printing data.tables.
26-
\describe{
27-
\item{\code{datatable.print.topn}}{An integer. When a data.table is printed,
28-
only the first topn and last topn rows are displayed.
29-
Default: \code{5L}.}
30-
\item{\code{datatable.print.nrows}}{An integer. The total number of rows
31-
to print before the topn logic is triggered.
32-
Default: \code{100L}.}
33-
\item{\code{datatable.print.class}}{A logical. If \code{TRUE}, the class of
34-
each column is printed below its name.
35-
Default: \code{FALSE}.}
36-
\item{\code{datatable.print.keys}}{A logical. If \code{TRUE}, the table's
37-
keys are printed above the data.
38-
Default: \code{FALSE}.}
39-
\item{\code{datatable.show.indices}}{A logical. A synonym for `datatable.print.keys` for historical reasons.
40-
Default: \code{TRUE}.}
41-
\item{\code{datatable.print.trunc.cols}}{A logical. If \code{TRUE} and a
42-
table has more columns than fit on the screen, it truncates the middle
43-
columns.
44-
Default: \code{FALSE}.}
45-
\item{\code{datatable.prettyprint.char}}{An integer. The maximum number of
46-
characters to display in a character column cell before truncating.
47-
Default: \code{100L}.}
48-
\item{\code{datatable.print.colnames}}{A logical. If \code{TRUE}, prints column names.
49-
Default: \code{TRUE}.}
50-
\item{\code{datatable.print.rownames}}{A logical. If \code{TRUE}, prints row numbers.
51-
Default: \code{TRUE}.}
25+
See \code{\link{print.data.table}} for a full description of printing data.tables.
26+
\describe{
27+
\item{\code{datatable.print.topn}}{An integer, default \code{5L}. When a data.table is printed,
28+
only the first topn and last topn rows are displayed.}
29+
\item{\code{datatable.print.nrows}}{An integer, default \code{100L}. The total number of rows
30+
to print before the topn logic is triggered.}
31+
\item{\code{datatable.print.class}}{A logical, default \code{FALSE}. If \code{TRUE}, the class of
32+
each column is printed below its name.}
33+
\item{\code{datatable.print.keys}}{A logical, default \code{FALSE}. If \code{TRUE}, the table's
34+
keys are printed above the data.}
35+
\item{\code{datatable.show.indices}}{A logical, default \code{TRUE}. A synonym for `datatable.print.keys` for historical reasons.}
36+
\item{\code{datatable.print.trunc.cols}}{A logical, default \code{FALSE}. If \code{TRUE} and a
37+
table has more columns than fit on the screen, it truncates the middle columns.}
38+
\item{\code{datatable.prettyprint.char}}{An integer, default \code{100L}. The maximum number of
39+
characters to display in a character column cell before truncating.}
40+
\item{\code{datatable.print.colnames}}{A logical, default \code{TRUE}. If \code{TRUE}, prints column names.}
41+
\item{\code{datatable.print.rownames}}{A logical, default \code{TRUE}. If \code{TRUE}, prints row numbers.}
5242
}
5343
}
5444

5545
\section{File I/O Options (fread and fwrite)}{
46+
See \code{\link{fread}} and \code{\link{fwrite}} for a full description of data.table I/O.
5647
\describe{
57-
\item{\code{datatable.fread.input.cmd.message}}{A logical. If \code{TRUE},
48+
\item{\code{datatable.fread.input.cmd.message}}{A logical, default \code{TRUE}. If \code{TRUE},
5849
`fread` will print the shell command it is using when the input is a
59-
command (e.g., `fread("grep ...")`).
60-
Default: \code{TRUE}. See \code{\link{fread}}.}
61-
\item{\code{datatable.fread.datatable}}{A logical. If \code{TRUE}, `fread`
62-
returns a `data.table`. If `FALSE`, it returns a `data.frame`.
63-
Default: \code{TRUE}.}
64-
\item{\code{datatable.integer64}}{A character string. Controls how `fread`
65-
handles 64-bit integers. Can be "integer64", "double", or "character".
66-
Default: \code{"integer64"}.}
67-
\item{\code{datatable.logical01}}{A logical. If \code{TRUE}, `fread` will
68-
interpret columns containing only 0 and 1 as logical.
69-
Default: \code{FALSE}.}
70-
\item{\code{datatable.keepLeadingZeros}}{A logical. If \code{TRUE}, `fread`
50+
command (e.g., `fread("grep ...")`).}
51+
\item{\code{datatable.fread.datatable}}{A logical, default \code{TRUE}. If \code{TRUE}, `fread`
52+
returns a `data.table`. If `FALSE`, it returns a `data.frame`.}
53+
\item{\code{datatable.integer64}}{A character string, default \code{"integer64"}. Controls how \code{fread}
54+
handles 64-bit integers. Can be "integer64", "double", or "character".}
55+
\item{\code{datatable.logical01}}{A logical, default \code{FALSE}. If \code{TRUE}, \code{fread} will
56+
interpret columns containing only 0 and 1 as logical.}
57+
\item{\code{datatable.keepLeadingZeros}}{A logical, default \code{FALSE}. If \code{TRUE}, \code{fread}
7158
preserves leading zeros in character columns by reading them as strings;
72-
otherwise they may be coerced to numeric.
73-
Default: \code{FALSE}.}
74-
\item{\code{datatable.logicalYN}}{A logical. If \code{TRUE}, `fread`
75-
will interpret "Y" and "N" as logical.
76-
Default: \code{FALSE}.}
77-
\item{\code{datatable.na.strings}}{A character vector. Global default for strings that
78-
`fread` should interpret as `NA`.
79-
Default: \code{"NA"}.}
80-
\item{\code{datatable.fwrite.sep}}{A character string. The default separator
81-
used by `fwrite`.
82-
Default: \code{","}.}
83-
\item{\code{datatable.showProgress}}{An integer or logical. Controls whether
84-
long-running operations like `fread` display a progress bar. Default
85-
is \code{interactive()}.}
59+
otherwise they may be coerced to numeric.}
60+
\item{\code{datatable.logicalYN}}{A logical, default \code{FALSE}. If \code{TRUE}, \code{fread}
61+
will interpret "Y" and "N" as logical.}
62+
\item{\code{datatable.na.strings}}{A character vector, default \code{"NA"}. Global default for strings that
63+
\code{fread} should interpret as \code{NA}.}
64+
\item{\code{datatable.fwrite.sep}}{A character string, default \code{","}. The default separator
65+
used by \code{fwrite}.}
66+
\item{\code{datatable.showProgress}}{An integer or logical, default \code{\link{interactive}()}. Controls whether
67+
long-running operations like `fread` display a progress bar.}
8668
}
8769
}
8870

8971
\section{Join and Subset Options}{
72+
See \code{\link{data.table}} for more related parameters and examples.
9073
\describe{
91-
\item{\code{datatable.allow.cartesian}}{A logical. A safety feature. If `FALSE`, a join
92-
is not allowed if the result would have more rows than the largest of the two tables.
93-
Default: \code{FALSE}. See \code{\link{data.table}}.}
94-
\item{\code{datatable.nomatch}}{Controls the behavior of non-matching rows in
95-
a join. The default is `NA`. Can be set to `0L` to drop non-matching rows.
96-
Default: \code{NA}.}
74+
\item{\code{datatable.allow.cartesian}}{A logical, default \code{FALSE}. A safety feature. If `FALSE`, a join
75+
is not allowed if the result would have more rows than the largest of the two tables.}
76+
\item{\code{datatable.nomatch}}{Default \code{NA}. Controls the behavior of non-matching rows in
77+
a join. Can be set to `0L` to drop non-matching rows.}
9778
}
9879
}
9980

10081
\section{Performance and Indexing Options}{
10182
\describe{
102-
\item{\code{datatable.auto.index}}{A logical. If \code{TRUE}, `data.table`
83+
\item{\code{datatable.auto.index}}{A logical, default \code{TRUE}. If \code{TRUE}, `data.table`
10384
automatically creates a secondary index on-the-fly when a column is first
104-
used in a subset, speeding up all subsequent queries.
105-
Default: \code{TRUE}.}
106-
\item{\code{datatable.use.index}}{A logical. A global switch to control
107-
whether existing secondary indices are used for subsetting.
108-
Default: \code{TRUE}.}
109-
\item{\code{datatable.forder.auto.index}}{A logical. Similar to `datatable.auto.index`,
110-
but applies to ordering operations (`forder`).
111-
Default: \code{TRUE}.}
112-
\item{\code{datatable.optimize}}{An integer controlling the GForce query
85+
used in a subset, speeding up all subsequent queries.}
86+
\item{\code{datatable.use.index}}{A logical, default \code{TRUE}. A global switch to control
87+
whether existing secondary indices are used for subsetting.}
88+
\item{\code{datatable.forder.auto.index}}{A logical, default \code{TRUE}. Similar to `datatable.auto.index`,
89+
but applies to ordering operations (`forder`).}
90+
\item{\code{datatable.optimize}}{A numeric, default \code{Inf}. Controls the GForce query
11391
optimization engine. The default enables all possible optimizations.
114-
See \code{\link{datatable.optimize}}.
115-
Default: \code{Inf}.}
116-
\item{\code{datatable.alloccol}}{An integer. Controls the number of column
92+
See \code{\link{datatable.optimize}}.}
93+
\item{\code{datatable.alloccol}}{An integer, default \code{1024L}. Controls the number of column
11794
slots to pre-allocate, improving performance when adding many columns.
118-
See \code{\link{alloc.col}}.
119-
Default: \code{1024L}.}
120-
\item{\code{datatable.reuse.sorting}}{A logical. If `TRUE`, `data.table`
121-
can reuse the sorted order of a table in joins, improving performance.
122-
Default: \code{TRUE}.}
95+
See \code{\link{alloc.col}}.}
96+
\item{\code{datatable.reuse.sorting}}{A logical, default \code{TRUE}. If `TRUE`, `data.table`
97+
can reuse the sorted order of a table in joins, improving performance.}
12398
}
12499
}
125100

126101
\section{Development and Verbosity Options}{
127102
\describe{
128-
\item{\code{datatable.quiet}}{A logical. The master switch to suppress all
129-
`data.table` status messages, including the startup message.
130-
Default: \code{FALSE}.}
131-
\item{\code{datatable.verbose}}{A logical. If \code{TRUE}, `data.table` will
132-
print detailed diagnostic information as it processes a query.
133-
Default: \code{FALSE}.}
134-
\item{\code{datatable.enlist}}{Experimental feature. If set to a function
103+
\item{\code{datatable.quiet}}{A logical, default \code{FALSE}. The master switch to suppress all
104+
`data.table` status messages, including the startup message.}
105+
\item{\code{datatable.verbose}}{A logical, default \code{FALSE}. If \code{TRUE}, `data.table` will
106+
print detailed diagnostic information as it processes a query.}
107+
\item{\code{datatable.enlist}}{Experimental feature. Default is \code{NULL}. If set to a function
135108
(e.g., `list`), the `j` expression can return a `list`, which will then
136-
be "enlisted" into columns in the result.
137-
Default: \code{NULL}.}
109+
be "enlisted" into columns in the result.}
138110
}
139111
}
140112

0 commit comments

Comments
 (0)