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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/openxlsx.R
\docType{data}
\name{openxlsx_options}
\alias{openxlsx_options}
\alias{op.openxlsx}
\alias{openxlsx_getOp}
\alias{openxlsx_setOp}
\title{openxlsx Options}
\format{
An object of class \code{list} of length 34.
}
\usage{
op.openxlsx
openxlsx_getOp(x, default = NULL)
openxlsx_setOp(x, value)
}
\arguments{
\item{x}{An option name (\code{"openxlsx."} prefix optional)}
\item{default}{A default value if \code{NULL}}
\item{value}{The new value for the option (optional if x is a named list)}
}
\description{
See and get the openxlsx options
}
\details{
\code{openxlsx_getOp()} retrieves the \code{"openxlsx"} options found in
\code{op.openxlsx}. If none are set (currently \code{NULL}) retrieves the
default option from \code{op.openxlsx}. This will also check that the
intended option is a standard option (listed in \code{op.openxlsx}) and
will provide a warning otherwise.
\code{openxlsx_setOp()} is a safer way to set an option as it will first
check that the option is a standard option (as above) before setting.
}
\examples{
openxlsx_getOp("borders")
op.openxlsx[["openxlsx.borders"]]
}
\keyword{datasets}
|
