File: options-RmetricsOptions.Rd

package info (click to toggle)
r-cran-timedate 3012.100-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 2,592 kB
  • ctags: 4
  • sloc: makefile: 13
file content (31 lines) | stat: -rw-r--r-- 666 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
\name{RmetricsOptions}
\alias{setRmetricsOptions}
\alias{getRmetricsOptions}
\alias{getRmetricsOption}

\title{Rmetrics Option Settings}

\description{
  Allow the user to set and examine a variety of global options which
  affect the way in which Rmetrics functions computes and displays its
  results.
}

\usage{
setRmetricsOptions(\dots)
getRmetricsOption(x, unset = "")
}


\arguments{
  \item{unset}{
    a character string holding the return value is x is not set.
  }
  \item{x}{
    a character string holding an option name.
  }
  \item{\dots}{
    any options can be defined, using \code{name = value} or by
    passing a list of such tagged values.
  }
}