Definition:
Human-readable file describing the project and dataset in detail. This is an OPTIONAL file, and only one README file should appear in dataset.
Properties:
| Property |
Value |
Description |
| baseDir |
/ |
Name of the directory under which the file object is expected to appear. |
| stem |
README |
Portion of the filename which excludes the extension. |
| arbitraryNesting |
False |
Indicator for whether a given file object is allowed to be nested within an arbitrary number of subdirectories. |
| extensions |
['.md', '.txt'] |
Extension of current file including initial dot |
If object not found:
| Property |
Value |
| code |
MISSING_README_DOC |
| level |
warning |
| reason |
It is recommended to include a 'README.md' or 'README.txt' file in the base directory |