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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BiocCheck.R
\name{BiocCheck}
\alias{BiocCheck}
\title{Check a package's adherence with the Bioconductor Package Guidelines}
\usage{
BiocCheck(
package = getwd(),
checkDir = dirname(package),
debug = FALSE,
callr = FALSE,
...
)
}
\arguments{
\item{package}{The path to an R package directory or tarball (\code{.tar.gz}).
The \code{BiocCheck} function is intended to be run from the package
directory; therefore, the current working directory (given by \code{getwd()})
is the default.}
\item{checkDir}{The directory where the \code{BiocCheck} output directory will be
stored. By default, it will be placed in the same directory as the package
directory i.e., \code{dirname(pkg_dir)}.}
\item{debug}{Whether to append the names of functions that correspond to
each condition raised by \code{BiocCheck} in the written log (i.e., in the
\code{'<package_name>.BiocCheck'} folder). This option is only relevant to
developers and contributors to \code{BiocCheck}.}
\item{callr}{logical(1) Whether to use the \code{callr} package to run \code{BiocCheck}
in an isolated R session to prevent namespace collisions.}
\item{\dots}{See the details section for available options. When running
\code{BiocCheck}, options can be specified as:
\preformatted{ BiocCheck(package, `no-check-vignettes`=TRUE) }}
}
\value{
\code{BiocCheck()} is chiefly called for the side effect of the check
reporting. The function also creates a \verb{<package_name>.BiocCheck} folder
and returns a \code{BiocCheck} reference class with three main list elements:
\itemize{
\item \strong{error}: Items to address before the package can be accepted
\item \strong{warning}: Strongly suggested items that may require attention
\item \strong{note}: Items to consider, though not required, before acceptance
}
}
\description{
Analyzes an R package for adherence with Bioconductor package guidelines and
best practices. The check outputs are categorized into ERROR, WARNING, and
NOTE. See the vignette for more details. \code{BiocCheck} is complementary
to \verb{R CMD check}, which should always be run first.
}
\details{
\code{BiocCheck()} reviews R packages for adherence with Bioconductor
package guidelines and best practices. See
\url{https://contributions.bioconductor.org} for the latest guidance for
writing Bioconductor software. Some rationale behind these best practices
can be seen in the vignette and pages in the \code{references} section. The
vignette also provides detailed explanations of all the checks performed by
\code{BiocCheck}.
\code{BiocCheck} is called within R with \preformatted{ BiocCheck(<package>)
} where \code{package} points to the source directory or the \code{.tar.gz}
tarball that was created using \verb{R CMD build}.
\emph{Note} that \code{BiocCheck} is complementary to \verb{R CMD check}.
\verb{R CMD check} should always be run first for best results.
}
\section{dot-options}{
\itemize{
\item \code{new-package}: enable checks specific to new packages
\item \code{no-check-dependencies}: disable check for bad dependencies
\item \code{no-check-deprecated}: disable check for usage of deprecated packages
\item \code{no-check-remotes}: disable check for usage of remote packages other
than those hosted on CRAN or Bioconductor
\item \code{no-check-version-num}: disable check for valid version number
\item \code{no-check-R-ver}: disable check for valid R version
\item \code{no-check-pkg-size}: disable check for package tarball size
\item \code{no-check-file-size}: disable check for individual file size
\item \code{no-check-bioc-views}: disable biocViews-specific checks (for non-BioC
packages)
\item \code{no-check-bbs}: disable BBS-specific checks (for non-BioC packages).
Valid DESCRIPTION
\item \code{no-check-description}: disable DESCRIPTION file checks
\item \code{no-check-vignettes}: disable vignette checks
\item \code{no-check-library-calls}: disable check usage of functions that
install or update packages
\item \code{no-check-install-self}: disable check for require or library of
itself
\item \code{no-check-coding-practices}: disable check for some common best coding
practices
\item \verb{no-check-function-len}: disable check for function length
\item \code{no-check-man-doc}: disable checks for man page documentation
\item \code{no-check-news}: disable checks for NEWS file
\item \code{no-check-unit-tests}: disable checks for unit tests
\item \code{no-check-skip-bioc-tests}: disable check for tests that skip when on
bioc
\item \code{no-check-formatting}: disable checks for file formatting
\item \code{no-check-CRAN}: disable check for if package exists in CRAN
\item \code{no-check-bioc-help}: disable check for registration on Bioconductor
mailing list and support site
\item \code{build-output-file}: file containing R CMD build output, for
additional analysis
\item \code{quit-with-status}: enable exit code option when performing check
}
}
\examples{
packageDir <- system.file("testpackages", "testpkg0", package="BiocCheck")
BiocCheck(packageDir, `quit-with-status`=FALSE)
}
\references{
\url{https://contributions.bioconductor.org}
}
\seealso{
\link{BiocCheck-class}, \link{Message-class}
}
\author{
Dan Tenenbaum, Lori Shepherd, and Marcel Ramos
}
|
