File: criteria.Rd

package info (click to toggle)
r-cran-rprojroot 2.0.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 496 kB
  • sloc: sh: 12; makefile: 7
file content (81 lines) | stat: -rw-r--r-- 1,777 bytes parent folder | download
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/root.R
\docType{data}
\name{criteria}
\alias{criteria}
\alias{is_rstudio_project}
\alias{is_r_package}
\alias{is_remake_project}
\alias{is_drake_project}
\alias{is_pkgdown_project}
\alias{is_renv_project}
\alias{is_projectile_project}
\alias{is_quarto_project}
\alias{is_git_root}
\alias{is_svn_root}
\alias{is_vcs_root}
\alias{is_testthat}
\alias{from_wd}
\title{Prespecified criteria}
\usage{
criteria

is_rstudio_project

is_r_package

is_remake_project

is_drake_project

is_pkgdown_project

is_renv_project

is_projectile_project

is_quarto_project

is_git_root

is_svn_root

is_vcs_root

is_testthat

from_wd
}
\description{
This is a collection of commonly used root criteria.
}
\details{
\code{is_rstudio_project} looks for a file with extension \code{.Rproj}.

\code{is_r_package} looks for a \code{DESCRIPTION} file.

\code{is_remake_project} looks for a \code{remake.yml} file.

\code{is_drake_project} looks for a \code{.drake} directory.

\code{is_pkgdown_project} looks for a \verb{_pkgdown.yml}, \verb{_pkgdown.yaml}, \verb{pkgdown/_pkgdown.yml} and/or \verb{inst/_pkgdown.yml} file.

\code{is_renv_project} looks for an \code{renv.lock} file.

\code{is_projectile_project} looks for a \code{.projectile} file.

\code{is_quarto_project} looks for a \verb{_quarto.yml} file.

\code{is_git_root} looks for a \code{.git} directory.

\code{is_svn_root} looks for a \code{.svn} directory.

\code{is_vcs_root} looks for the root of a version control
system, currently only Git and SVN are supported.

\code{is_testthat} looks for the \code{testthat} directory, works when
developing, testing, and checking a package.

\code{from_wd} uses the current working directory.
}
\keyword{datasets}