matrixStats.options: Options used for matrixStats

In HenrikBengtsson/matrixStats: Functions that Apply to Rows and Columns of Matrices (and to Vectors)

Options used for matrixStats

Description

Below are the R options and environment variables that are used by the matrixStats package and packages enhancing it.

WARNING: Note that the names and the default values of these options may change in future versions of the package. Please use with care until further notice.

Options for controlling deprecation

matrixStats.center.onUse:

(string) Action taken when argument center is specified. If "defunct", an error is thrown. If "deprecated", a warning is signaled. If "ignore", it's silently ignored. (Default: "ignore")

matrixStats.center.onScalar:

(string) Action taken when argument center is a scalar. If "defunct", an error is thrown. If "deprecated", a warning is signaled. If "ignore", it's silently ignored. (Default: "deprecated")

matrixStats.formula.onMistake:

(string) Action taken when argument center is specified with the wrong assumptions of the underlying formula used internally. If "defunct", an error is thrown. If "deprecated", a warning is signaled. (Default: "defunct")

matrixStats.formula.freq:

(numeric) Controls how often the above assumption is checked. (Default: 50 - every 50:th call starting with the first)

matrixStats.ties.method.missing:

(string) Controls whether argument ties.method for colRanks() and rowRanks() should be explicitly specified. If "defunct", an error is produced, if not. If "deprecated", a warning is signaled. If "ignore", it's silently ignored. (Default: "deprecated" in R (>= 4.4.0), otherwise "ignore")

matrixStats.ties.method.freq:

(numeric) Controls how often the above validation is checked. (Default: 25 - every 25:th call starting with the first)

matrixStats.useNames.NA:

(string) Action taken when argument useNames is set to NA. If "defunct", an error is thrown. If "deprecated", a warning is signaled. (Default: "defunct")

Environment variables that set R options

All of the above R matrixStats.* options can be set by corresponding environment variable R_MATRIXSTATS_* when the matrixStats package is loaded. For example, if R_MATRIXSTATS_USENAMES_NA=defunct, then option matrixStats.useNames.NA is set to "defunct" (string).

Examples

## Not run: 
options(matrixStats.useNames.NA = "defunct")

## End(Not run)

HenrikBengtsson/matrixStats documentation built on Nov. 15, 2024, 3:20 p.m.