About this website

_{⇠ back}

This is a demo repository with the skeleton to build a data index from metadata tables. You can fork this repository and edit its content to use it for your own metadata.

Sections

The main contents of this site are the following:

Research Data Index

Contains metadata and protocol associated to research data. It is organized as follows:

    Research Data Index/
           └── <datatype>
                 └── <facility>
                        ├── data_organization
                        ├── metadata_tables
                        └── protocols

• <datatype> : name describing the data type (e.g., Microscopy)
• <facility>: name describing the facility
• data_organization: section describing folder organization and filenaming convention for a specific data type and facility
• metadata_tables: tabular data in CSV with metadata containing one table with information about subjects (subjects_*), with one subject per row, and one table with information about the files for each subject (files_*), with multiple rows per subject.
• Protocols: documents with data acquisition protocols, Standard Operating Procedures, etc

Metadata specifications

Specifies organization and filenaming convention at the level of the entire project.

Glossary

Describes terms and abbreviations used at the level of the entire project.

Naming convention

We use <label1-sublabel1>_<label2-sublabel2>

• Underscore (_) separate parts (keys) in a filename (e.g, subject and task)

• Hyphen (-) separate elements within one part when needed (e.g., facility-1 )

• For each value key and value are written together (e.g., s001 )

• <\> are used to indicate a key or keyvalue pair

• [] indicates optional input

Additional tutorials

Here we provide some additional materials from our AFFORD website that can be useful when editing your own repository and curating your metadata.