-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathcheck_lintr.Rd
40 lines (39 loc) · 1.31 KB
/
check_lintr.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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/check_lintr.R
\name{check_lintr}
\alias{check_lintr}
\title{Check the packages for linters}
\usage{
check_lintr(x = ".", quiet = FALSE)
}
\arguments{
\item{x}{Either a \code{checklist} object or a path to the source code.
Defaults to \code{.}.}
\item{quiet}{Whether to print check output during checking.}
}
\description{
This functions does \href{https://en.wikipedia.org/wiki/Static_program_analysis}{static code analysis}.
It relies on \code{\link[lintr:lint]{lintr::lint_package()}}.
We recommend that you activate all code diagnostics in RStudio to help
meeting the requirements.
You can find this in the menu \emph{Tools} > \emph{Global options} > \emph{Code} >
\emph{Diagnostics}.
Please have a look at \code{vignette("philosophy")} for more details on the rules.
}
\seealso{
Other both:
\code{\link{add_badges}()},
\code{\link{check_filename}()},
\code{\link{check_spelling}()},
\code{\link{custom_dictionary}()},
\code{\link{default_organisation}()},
\code{\link{print.checklist_spelling}()},
\code{\link{read_checklist}()},
\code{\link{read_organisation}()},
\code{\link{update_citation}()},
\code{\link{write_checklist}()},
\code{\link{write_citation_cff}()},
\code{\link{write_organisation}()},
\code{\link{write_zenodo_json}()}
}
\concept{both}