- filename
Either the filename for a file to lint, or a character string of inline R code for linting.
The latter (inline data) applies whenever filename
has a newline character (\n).
- linters
A named list of linter functions to apply. See linters for a full list of default and available
linters.
- ...
Provide additional arguments to be passed to:
- cache
When logical, toggle caching of lint results. I1f passed a character string, store the cache in this
directory.
- parse_settings
Logical, default TRUE
. Whether to try and parse the settings;
otherwise, the default_settings()
are used.
- text
Optional argument for supplying a string or lines directly, e.g. if the file is already in memory or
linting is being done ad hoc.
- path
For the base directory of the project (for lint_dir()
) or
package (for lint_package()
).
- relative_path
if TRUE
, file paths are printed using their path relative to the base directory.
If FALSE
, use the full absolute path.
- exclusions
exclusions for exclude()
, relative to the package path.
- pattern
pattern for files, by default it will take files with any of the extensions
.R, .Rmd, .qmd, .Rnw, .Rhtml, .Rrst, .Rtex, .Rtxt allowing for lowercase r (.r, ...).
- show_progress
Logical controlling whether to show linting progress with a simple text
progress bar via utils::txtProgressBar()
. The default behavior is to show progress in
interactive()
sessions not running a testthat suite.