Skip to content

DATA_AVAILABILITY_TEMPLATE.md

Latest commit

 

History

History
45 lines (30 loc) · 2.07 KB

DATA_AVAILABILITY_TEMPLATE.md

File metadata and controls

45 lines (30 loc) · 2.07 KB
Raw

Data Availability Template

Use this file as a drafting aid when preparing a manuscript, poster, thesis, report, repository README, or archive record.

Replace all bracketed text before public release.

General statement

The data and analysis materials supporting this project are available at:

  • Data archive: [add DOI or URL]
  • Software repository: [add GitHub repository URL]
  • Software archive: [add DOI or URL, if applicable]

Manuscript-style template

The original data presented in this study are openly available in [repository/archive name] at [DOI or URL]. The archived dataset includes [briefly describe raw data, processed data, metadata, or supporting documentation]. The accompanying analysis workflow is available in the [repository name] GitHub repository at [repository URL]. The archived software release used for the reported analysis is available at [software DOI or release URL].

Restricted or partial data template

Some data generated or analyzed during this study are not publicly available because [state reason: size, collaborator restrictions, privacy, proprietary constraints, unpublished follow-up work, or institutional policy]. Publicly shareable data and analysis documentation are available at [DOI or URL]. Additional information may be available from the corresponding author upon reasonable request and with approval from the project lead or PI.

Software citation template

Analysis code used for this project is available at:

GitHub repository: [repository URL]
Archived release: [release DOI or URL]
Version: [version tag]
Access date: [date]

Data archive checklist

Before finalizing a data availability statement, confirm:

  • The repository URL is correct.
  • The release tag is correct.
  • The DOI resolves correctly.
  • The dataset description matches the actual archived files.
  • Raw versus processed data are described accurately.
  • Restricted or excluded data are explained.
  • The PI or project lead approved the public data statement.
  • The statement matches the journal, thesis, or conference requirements.