File: setOption.Options.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (46 lines) | stat: -rw-r--r-- 1,204 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  Options.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{setOption.Options}
\alias{setOption.Options}
\alias{Options.setOption}
\alias{setOption,Options-method}

\title{Sets an option}

\description{
 Sets an option in the options tree structure.
}

\usage{
\method{setOption}{Options}(this, pathname, value, overwrite=TRUE, ...)
}

\arguments{
  \item{pathname}{A single \code{\link[base]{character}} string specifying the path to the
     option.}
  \item{value}{The value to be assigned to the option.}
  \item{overwrite}{If \code{\link[base:logical]{TRUE}}, already existing options are overwritten,
     otherwise not.}
  \item{...}{Not used.}
}

\value{Returns (invisibly) the old option value.}

\author{Henrik Bengtsson}

\seealso{
  \code{\link[R.utils:hasOption.Options]{*hasOption}()}.
  \code{\link[R.utils:setOption.Options]{*setOption}()}.
  For more information see \code{\link{Options}}.
}


\keyword{internal}
\keyword{methods}
\keyword{programming}