available_linters {lintr} | R Documentation |
Get Linter metadata from a package
Description
available_linters()
obtains a tagged list of all Linters available in a package.
available_tags()
searches for available tags.
Usage
available_linters(packages = "lintr", tags = NULL, exclude_tags = "deprecated")
available_tags(packages = "lintr")
Arguments
packages |
A character vector of packages to search for linters. |
tags |
Optional character vector of tags to search. Only linters with at least one matching tag will be
returned. If |
exclude_tags |
Tags to exclude from the results. Linters with at least one matching tag will not be returned.
If |
Value
available_linters
returns a data frame with columns 'linter', 'package' and 'tags':
- linter
A character column naming the function associated with the linter.
- package
A character column containing the name of the package providing the linter.
- tags
A list column containing tags associated with the linter.
available_tags
returns a character vector of linter tags used by the packages.
Package Authors
To implement available_linters()
for your package, include a file inst/lintr/linters.csv
in your
package.
The CSV file must contain the columns 'linter' and 'tags', and be UTF-8 encoded.
Additional columns will be silently ignored if present and the columns are identified by name.
Each row describes a linter by
its function name (e.g.
"assignment_linter"
) in the column 'linter'.space-separated tags associated with the linter (e.g.
"style consistency default"
) in the column 'tags'.
Tags should be snake_case.
See available_tags("lintr")
to find out what tags are already used by lintr.
See Also
-
linters for a complete list of linters available in lintr.
-
available_tags()
to retrieve the set of valid tags.
Examples
lintr_linters <- available_linters()
# If the package doesn't exist or isn't installed, an empty data frame will be returned
available_linters("does-not-exist")
lintr_linters2 <- available_linters(c("lintr", "does-not-exist"))
identical(lintr_linters, lintr_linters2)
available_tags()