A consistent naming schema avoids problems when working together,
especially when working with different OS.
Some OS (e.g. Windows) are case-insensitive whereas others (e.g. Linux) are
case-sensitive.
Note that the checklist GitHub Actions will test your code on Linux,
Windows and MacOS.
Details
The sections below describe the default rules.
We allow several exceptions when the community standard is different.
E.g. a package stores the function scripts in the R folder, while our
standard enforces lower case folder names.
Use the community standard, even if it does not conform with the checklist
rules.
Most likely checklist will have an exception for the name.
If not, you can file an issue and
motivate why you think we should add an exception.
Rules for folder names
Folder names should only contain lower case letters, numbers, dashes (
-) and underscores (_).They can start with a single dot (
.).
Default rules for file names
Base names should only contain lower case letters, numbers, dashes (
-) and underscores (_).File extensions should only contain lower case letters and numbers. Exceptions: file extensions related to
Rmust have an upper caseR(.R,.Rd,.Rda,.Rnw,.Rmd,.Rproj). Exception to these exceptions:R/sysdata.rda.
Exceptions for some file formats
Underscores (_) causes problems for graphical files when using LaTeX to
create pdf output.
This is how we generate pdf output from rmarkdown.
Therefore you need to use a dash (-) as separator instead of
an underscores (_).
Applies to files with extensions eps, jpg, jpeg, pdf, png, ps, svg and .cls.
We ignore files with .otf or .ttf extensions.
These are fonts files which often require their own file name scheme.
See also
Other both:
add_badges(),
check_lintr(),
check_spelling(),
custom_dictionary(),
default_organisation(),
print.checklist_spelling(),
read_checklist(),
read_organisation(),
write_checklist(),
write_organisation()