-
Notifications
You must be signed in to change notification settings - Fork 131
/
Copy pathuse_recommended.Rd
46 lines (40 loc) · 1.32 KB
/
use_recommended.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
37
38
39
40
41
42
43
44
45
46
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/use_recommended.R
\name{use_recommended_deps}
\alias{use_recommended_deps}
\alias{use_recommended_tests}
\title{Add recommended elements}
\usage{
use_recommended_deps(
pkg = get_golem_wd(),
recommended = c("shiny", "DT", "attempt", "glue", "htmltools", "golem")
)
use_recommended_tests(
pkg = get_golem_wd(),
spellcheck = TRUE,
vignettes = TRUE,
lang = "en-US",
error = FALSE
)
}
\arguments{
\item{pkg}{Path to the root of the package. Default is \code{get_golem_wd()}.}
\item{recommended}{A vector of recommended packages.}
\item{spellcheck}{Whether or not to use a spellcheck test.}
\item{vignettes}{Logical, \code{TRUE} to spell check all \code{rmd} and \code{rnw} files in
the \verb{vignettes/} folder.}
\item{lang}{Preferred spelling language. Usually either \code{"en-US"} or
\code{"en-GB"}.}
\item{error}{Logical, indicating whether the unit test should fail if
spelling errors are found. Defaults to \code{FALSE}, which does not error, but
prints potential spelling errors}
}
\value{
Used for side-effects.
}
\description{
\describe{
\item{use_recommended_deps}{Adds \code{shiny}, \code{DT}, \code{attempt}, \code{glue}, \code{golem}, \code{htmltools} to dependencies}
\item{use_recommended_tests}{Adds a test folder and copy the golem tests}
}
}