File: writeRStudioPreference.Rd

package info (click to toggle)
r-cran-rstudioapi 0.17.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 916 kB
  • sloc: makefile: 2
file content (43 lines) | stat: -rw-r--r-- 1,176 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prefs.R
\name{writeRStudioPreference}
\alias{writeRStudioPreference}
\title{Write RStudio Preference}
\usage{
writeRStudioPreference(name, value)
}
\arguments{
\item{name}{The name of the preference.}

\item{value}{The value of the preference.}
}
\description{
Writes an internal RStudio IDE preference for the current user.
}
\details{
RStudio IDE internal preferences include the values displayed in RStudio's
Global Options dialog as well as a number of additional settings. Set them
carefully; inappropriate values can cause unexpected behavior. See the
RStudio Server Professional Administration Guide appendix for your version
of RStudio for a full list of preference names and values.
}
\note{
The \code{writeRStudioPreference} function was added in version
1.3.387 of RStudio.
}
\examples{

\dontrun{
# Hide RStudio's toolbar.
rstudioapi::writeRStudioPreference("toolbar_visible", FALSE)
}


}
\seealso{
\code{\link{writePreference}}, which can be used to store arbitrary
user (non-RStudio) preferences.

\code{\link{readRStudioPreference}}, which reads internal RStudio IDE
preferences.
}