R Graphical Manual

Browse All

Last data update: 2014.03.03

R: Options for globaltest package

gt.options

R Documentation

Options for globaltest package

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: j.j.goeman@lumc.nl

Examples

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

  # reading options
  gt.options()

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(globaltest)
Loading required package: survival
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/globaltest/gtoptions.Rd_%03d_medium.png", width=480, height=480)
> ### Name: gt.options
> ### Title: Options for globaltest package
> ### Aliases: gt.options
> ### Keywords: htest
> 
> ### ** Examples
> 
>   # setting options
>   gt.options(max.print=45, trim=TRUE)
> 
>   # reading options
>   gt.options()
$trim
[1] TRUE

$transpose
[1] FALSE

$max.print
[1] 45

$warn.deprecated
[1] TRUE

$trace
[1] FALSE

> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>