forked from r-lib/usethis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
use_rmarkdown_template.Rd
36 lines (33 loc) · 1.09 KB
/
use_rmarkdown_template.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rmarkdown.R
\name{use_rmarkdown_template}
\alias{use_rmarkdown_template}
\title{Add an RMarkdown Template}
\usage{
use_rmarkdown_template(template_name = "Template Name",
template_dir = asciify(template_name),
template_description = "A description of the template",
template_create_dir = FALSE)
}
\arguments{
\item{template_name}{The name as printed in the template menu.}
\item{template_dir}{Name of the directory the template will live in within
\code{inst/rmarkdown/templates}.}
\item{template_description}{Sets the value of \code{description} in
\code{template.yml}.}
\item{template_create_dir}{Sets the value of \code{create_dir} in \code{template.yml}.}
}
\description{
Adds files and directories necessary to add a custom rmarkdown template to
RStudio. It creates:
\itemize{
\item \code{inst/rmarkdown/templates/{{template_dir}}}. Main directory.
\item \code{skeleton/skeleton.Rmd}. Your template Rmd file.
\item \code{template.yml} with basic information filled in.
}
}
\examples{
\dontrun{
use_rmarkdown_template()
}
}