REPO_NAME

This repository contains SHORT_DESCRIPTION. The data in this repository is openly available to everyone and is intended to support reproducible research.

GitHub issues GitHub forks GitHub stars Code license Data license DOI

Repository Structure

The structure of this repository follows the Advanced Structure for Data Analysis of The Turing Way and is organized as follows:

  • analysis/: scripts and notebooks used to analyze the data
  • assets/: images, logos, etc. used in the README and other documentation
  • build/: scripts and notebooks used to build the data
  • data/: data files
  • docs/: documentation for the data and the repository
  • project-management/: project management documents (e.g., meeting notes, project plans, etc.)
  • src/: source code for the data (e.g., scripts used to collect or process the data)
  • test/: tests for the data and source code
  • report.md: a report describing the analysis of the data

Data Description

  • TODO Describe the data in this repository, including what it represents, how it was collected or obtained, any preprocessing or cleaning that was done, and any limitations or potential biases.
  • TODO Data models, including field names, descriptions, and controlled values, should be clearly documented in a static document that is maintained with the data and is part of the products.
  • TODO All rights and intellectual property issues should be clearly documented. Where possible, data and products should be released under open licenses (Creative Commons, GNU, BSD, MPL).

Use

These data are openly available to everyone and can be used for any research or educational purpose. If you use this data in your research, please cite as specified in CITATION.cff. The following citation formats are also available through Zenodo:

Zenodo provides an API (REST & OAI-PMH) to access the data. For example, the following command will return the metadata for the most recent version of the data

curl -i https://zenodo.org/api/records/ZENODO_RECORD

Support

This project is maintained by @USERNAME. Please understand that we can’t provide individual support via email. We also believe that help is much more valuable when it’s shared publicly, so more people can benefit from it.

Type Platforms
🚨 Bug Reports GitHub Issue Tracker
πŸ“Š Report bad data GitHub Issue Tracker
πŸ“š Docs Issue GitHub Issue Tracker
🎁 Feature Requests GitHub Issue Tracker
πŸ›‘ Report a security vulnerability See SECURITY.md
πŸ’¬ General Questions GitHub Discussions

Roadmap

No changes are currently planned.

Contributing

All contributions to this repository are welcome! If you find errors or problems with the data, or if you want to add new data or features, please open an issue or pull request. Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

Versioning

We use SemVer for versioning. The available versions are listed in the tags on this repository.

Authors and acknowledgment

See also the list of contributors who contributed to this project.

License

The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the LICENSE-CCBY file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made.

The code in this repository is released under the GNU Affero General Public License v3.0 - see the LICENSE-AGPL file for details. By using this code, you agree to make any modifications available under the same license.

Back to top