-
Notifications
You must be signed in to change notification settings - Fork 0
/
chk_make.Rd
52 lines (47 loc) · 1.67 KB
/
chk_make.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
47
48
49
50
51
52
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/maker.R
\name{chk_make}
\alias{chk_make}
\title{Makes a yaml file with required packages etc}
\usage{
chk_make(path, programs, packages, options)
}
\arguments{
\item{path}{File name and path. If missing will print to screen.}
\item{programs}{data.frame of required programs.}
\item{packages}{data.frame of required packages}
\item{options}{data.frame of recommended RStudio options}
}
\description{
Makes a yaml file with required packages etc
}
\details{
Programs are checked against names of programs known by checker.
Unknown programs are ignored with a message. packages are checked against
installed packages. A message is given if there are any unknown packages.
options are checked against a curated list of RStudio options taken
from \code{usethis:::rstudio_prefs_read()}.
See also \url{https://docs.posit.co/ide/server-pro/session_user_settings/session_user_settings.html}.
A message is given if any are not recognised.
}
\examples{
pak <- read.csv(
text = "package, recommended, minimum, message
dplyr, 1.0.9, NA, NA
ggplot2, 3.3.5, 3.3.1, NA",
strip.white = TRUE
)
prog <- read.csv(text = 'program, recommended, minimum, message
rstudio, 2022.7.1.554, NA, NA
R, "4.2.1", "4.1.1", NA
git, NA, NA, NA',
strip.white = TRUE)
opt <- read.csv(text = 'option, value, message
"save_workspace", "never", NA
"load_workspace", "FALSE", "For reproducibility"',
strip.white = TRUE)
f <- tempfile(fileext = ".yaml")
(chk_make(path = f, programs = prog, packages = pak, options = opt))
#chk_requirements(f)
unlink(f)
}