gtoptions: Options for globaltest package

In jellegoeman/globaltest: Testing Groups of Covariates/Features for Association with a Response Variable, with Applications to Gene Set Testing

Description

Sets various global options for the functions in the globaltest package.

Usage

gt.options (trace, trim, transpose, max.print, warn.deprecated)

Arguments

trace	(Default: TRUE). If TRUE, prints progress information whenever many tests are to be performed. Such printing of progress information involves the printing of backspace characters, which is not compatible with use of Sweave.
trim	(Default: FALSE). If FALSE, returns an error if covariates in the subsets argument of gt are not present in the data; if TRUE, silently removes these covariates, and remove duplicates.
transpose	(Default: FALSE). If TRUE, gt expects the transposed data format that is usual in genomics, in which the subjects correspond to the columns of the data matrix and the covariates (or probes) are the rows. If FALSE, gt expects the usual statistical format instead.
max.print	(Default: Inf). The maximum number of characters to print for the alias.
warn.deprecated	(Default: TRUE). Whether or not to give a warning when the deprecated globaltest function is called.

Details

The globaltest options can be set during a session, and apply to all calls to functions in the globaltest package for the rest of the session. They are not remembered between sessions.

Author(s)

Jelle Goeman: [e-mail]

See Also

The gt function.

Examples

  # setting options
  gt.options(max.print=45, trim=TRUE)

  # reading options
  gt.options()

jellegoeman/globaltest documentation built on Dec. 29, 2021, 9:11 p.m.