Skip to content

Instantly share code, notes, and snippets.

@guilbep
Created March 31, 2025 11:14
Show Gist options
  • Save guilbep/94b727086cb827396cd17cea365d83d4 to your computer and use it in GitHub Desktop.
Save guilbep/94b727086cb827396cd17cea365d83d4 to your computer and use it in GitHub Desktop.

README for Research Dataset

Dataset Information

  • Title: [Dataset Title]
  • Created: March 31, 2025
  • Version: 1.0
  • Authors: [Author Names and Affiliations]
  • Contact: [Contact Email]

Description

[Provide a concise description of the dataset, including its purpose, scope, and the research questions it addresses. Explain the context of data collection and highlight any unique or valuable aspects of the dataset.]

Data Collection

  • Date Range: [Start Date] to [End Date]
  • Location: [Geographic Information]
  • Collection Method: [Brief description of instruments, protocols, or methods used]
  • Sample Size: [Number of samples/observations]

Data Structure

The dataset consists of the following files:

  • data/ - Directory containing all data files
    • raw/ - Raw, unprocessed data
    • processed/ - Cleaned and processed data
  • metadata/ - Directory containing metadata files
  • scripts/ - Analysis and processing scripts
  • documentation/ - Extended documentation

File Formats

  • Data files are provided in [format(s)] (e.g., CSV, NetCDF, HDF5)
  • All tabular data includes headers
  • Missing values are represented as [representation]

Variables

Variable Name Description Units Type Range/Values
[var_name] [description] [units] [data type] [range]
[var_name] [description] [units] [data type] [range]

Quality Assurance

[Describe quality control measures, validation methods, and known limitations or biases in the data]

Usage Rights and Citation

This dataset is published under [license type] license. When using this data, please cite:

[Authors], ([Year]). [Dataset Title]. [Repository/Publisher]. [DOI/URL]

Related Publications

[List any publications that use or describe this dataset]

Acknowledgments

[List funding sources, collaborators, or other acknowledgments]

How to Use This Dataset

[Provide basic instructions on how to load and start working with the data, with simple code examples if appropriate]

# Example code to load and explore the dataset
import pandas as pd

# Load the data
data = pd.read_csv('data/processed/main_dataset.csv')

# Display basic information
print(data.info())
print(data.describe())

Version History

  • v1.0 (March 31, 2025): Initial release

Additional Resources

  • [Project website]
  • [Repository link]
  • [Documentation link]

This README follows the EPFL Open Research Data best practices. For more information on these guidelines, please visit the EPFL Research Data Management website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment