File: createProjectTemplate.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 (53 lines) | stat: -rw-r--r-- 1,654 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
44
45
46
47
48
49
50
51
52
53
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/templates.R
\name{createProjectTemplate}
\alias{createProjectTemplate}
\title{Create a Project Template}
\usage{
createProjectTemplate(
  package = ".",
  binding,
  title,
  subtitle = paste("Create a new", title),
  caption = paste("Create", title),
  icon = NULL,
  open_files = NULL,
  overwrite = FALSE,
  edit = TRUE
)
}
\arguments{
\item{package}{The path to an package sources.}

\item{binding}{The skeleton function to associate with this project
template. This is the name of the function that will be used to initialize
the project.}

\item{title}{The title to be shown within the \strong{New Project...}
wizard.}

\item{subtitle}{(optional) The subtitle to be shown within the \strong{New
Project...} wizard.}

\item{caption}{(optional) The caption to be shown on the landing page for
this template.}

\item{icon}{(optional) The path to an icon, on disk, to be used in the
dialog. Must be an \code{.png} of size less than 64KB.}

\item{open_files}{(optional) Files that should be opened by RStudio when the
project is generated. Shell-style globs can be used to indicate when
multiple files matching some pattern should be opened -- for example,
OpenFiles: R/*.R would indicate that RStudio should open all .R files within
the R folder of the generated project.}

\item{overwrite}{Boolean; overwrite a pre-existing template file if one
exists?}

\item{edit}{Boolean; open the file for editting after creation?}
}
\description{
Create a project template. See
\url{https://rstudio.github.io/rstudio-extensions/rstudio_project_templates.html}
for more information.
}