Check that object names conform to a naming style. The default naming styles are "snake_case" and "symbols".
Usage
object_name_linter(styles = c("snake_case", "symbols"))Arguments
- styles
A subset of ‘symbols’, ‘CamelCase’, ‘camelCase’, ‘snake_case’, ‘SNAKE_CASE’, ‘dotted.case’, ‘lowercase’, ‘UPPERCASE’ . A name should match at least one of these styles.
Details
Note when used in a package, in order to ignore objects imported
from other namespaces, this linter will attempt getNamespaceExports()
whenever an import(PKG) or importFrom(PKG, ...) statement is found
in your NAMESPACE file. If requireNamespace() fails (e.g., the package
is not yet installed), the linter won't be able to ignore some usages
that would otherwise be allowed.
Suppose, for example, you have import(upstream) in your NAMESPACE,
which makes available its exported S3 generic function
a_really_quite_long_function_name that you then extend in your package
by defining a corresponding method for your class my_class.
Then, if upstream is not installed when this linter runs, a lint
will be thrown on this object (even though you don't "own" its full name).
The best way to get lintr to work correctly is to install the package so that it's available in the session where this linter is running.
See also
linters for a complete list of linters available in lintr.