Skip to content

Releases: AgrDataSci/template-repo-data-analysis

Winds of spring

23 Apr 08:16
@kauedesousa kauedesousa
v1.1
25d4c33
Compare
Choose a tag to compare
Winds of spring Latest
Latest

Data-driven research faces several challenges, including inadequate data documentation, inconsistent structure, and poor reproducibility. Researchers often struggle with these aspects, lacking practical examples or accessible tools. To address these issues, we created a project-oriented, easy-to-use data template. It streamlines metadata management, facilitates reproducibility, and ensures alignment with FAIR principles.

The template repository includes clear, intuitive folder structures and essential resources.

template-repo-data-analysis/
|-- data/                                       # Anonimized raw and cleaned datasets
|-- docs/                                       # Reports or additional documentation
|-- metadata/                                   # Metadata files and templates
|    |-- project-metadata.xlsx                  # Project metadata
|    |-- project-metadata.json                  # Project metadata for DataCite
|    |-- example-metadata-data-mip-uganda.csv   # Description of the dataset (example)
|    |-- README.md    
|-- output/                                     # Model results, figures, tables
|-- script/                                     # Data analysis scripts
|-- .gitignore                                  # List of files to exclude from Git
|-- LICENSE                                     # License stablishing the rights to use
|-- CITATION.cff                                # Used by Zenodo to generate citation
|-- template-repo-data-analysis.Rproj           # RStudio file to set up the environment 
|-- README.md                                   # Project overview
Assets 2
Loading

Seed release

15 Apr 14:47
@kauedesousa kauedesousa
v1.0
cedf7bd
Compare
Choose a tag to compare
Seed release

This first release introduces a reusable, project-oriented repository structure designed to support FAIR (Findable, Accessible, Interoperable, and Reusable) data workflows in research. The template includes a well-organized directory layout, standardized metadata formats, and automated R scripts for validating and generating metadata compatible with Zenodo and DataCite.

Key features:

  • Project-oriented structure for tidy and reproducible workflows
  • FAIR-aligned metadata (metadata.xlsx, metadata.json)
  • CITATION.cff file for GitHub-Zenodo citation integration
  • Validation and metadata generation scripts in base R
  • Ready for versioned data releases and open science publishing

This release is aimed at researchers, data managers, and collaborative teams looking to publish reproducible and well-documented research outputs. Suggestions and contributions are welcome!

Loading