File: addTheme.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 (31 lines) | stat: -rw-r--r-- 1,108 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/themes.R
\name{addTheme}
\alias{addTheme}
\title{Add a Custom Editor Theme}
\usage{
addTheme(themePath, apply = FALSE, force = FALSE, globally = FALSE)
}
\arguments{
\item{themePath}{A full or relative path or URL to an \code{rstheme} or
\code{tmtheme} to be added.}

\item{apply}{Whether to immediately apply the newly added theme. Setting
this to \code{TRUE} has the same impact as running \code{{
rstudioapi::addTheme(<themePath>); rstudioapi::applyTheme(<themeName>)
}}.\cr Default: \code{FALSE}.}

\item{force}{Whether to force the operation and overwrite an existing file
with the same name.\cr Default: \code{FALSE}.}

\item{globally}{Whether to install this theme for the current user or all
users. If set to \code{TRUE} this will attempt to install the theme for all
users, which may require administrator privileges.\cr Default: \code{FALSE}.}
}
\description{
Adds a custom editor theme to RStudio and returns the name of the newly
added theme.
}
\note{
The \code{addTheme} function was introduced in RStudio 1.2.879.
}