Lints¶

These are the linting checks that are currently supported.

code_results_subdir_pairing¶

Check that every subdirectory within the project's code directory has a corresponding subdirectory with the same name in the results directory, and vice versa.

code_results_subdir_regex¶

All subdirectories within the project's code and results directory should have names that match the regular expression in code_results_subdir_regex.

code_subdir_readmes¶

Each subdirectory within the project's code directory should contain a README file. Acceptable READMEs are configured with the readme_names option.

code_subdir_workflows¶

Each subdirectory within the project's code directory should contain a workflow file. Acceptable workflow files are configured with the workflow_names option.

data_subdir_readmes¶

Each subdirectory within the project's data directory should contain a README file. Datasets that are symbolic links to other files on your computer, HPC cluster, or remote environment are excluded from this check.

root_dirs¶

Check for a set of required directories that should be present in the project's root directory. For details, see Root Directories.

root_files¶

Check for a set of required files that should be present in the project's root directory.