Module instantiated_config 

Creating and using the internal representation of all the important files, directories, and lints to check.

Structs

InstantiatedConfig

The internal representation of all the important files, directories, and lints to check.

RootDirs

Expected top-level directories to organize the project folder.

Statics

CODE_RESULTS_SUBDIR_REGEX 🔒

The default regular expression for code and results folders to match against. The format is YYYY-MM-DD_kebab-case-brief-description.

README_FILE_NAMES 🔒

The default accepted file names of the READMEs that should be present in the project root and within each subdirectory in the code and data directories.

WORKFLOW_FILE_NAMES 🔒

The default accepted file names of the workflow files that should be present within each subdirectory in the code directory.

Functions

parse_root_dir_name 🔒

A helper function to parse the directory name for a root directory.