Good Data Practices

Best practices for creating reusable data publications

So, you want to share your research data in Dryad, but are unsure where to start or what you 'should' share? Don't worry, it's not always clear how to craft a dataset with reusability in mind.

We want to help you share your research with the scientific community to increase its visibility and foster collaborations. The following guidelines will help make your Dryad datasets as Findable, Accessible, Interoperable, and Reusable (FAIR) as possible.

No time to dig into the details? Check out our quickstart guide to data sharing.

Contents:

• Gather all relevant data needed for reanalysis
• Make sure your data are shareable
• Make sure your data are accessible
• Organize files in a logical schema
• Describe your dataset in a README file
• Examples of good reusability practices
• Further resources

Gather all relevant data needed for reanalysis

• Consider all of the information necessary for one to reuse your dataset and replicate the analyses in your publication. Gather and organize everything—this may include experimental method details, raw data files, organized data tables, scripts, data visualizations, and statistical output. There are often several levels of data processing involved in a project, and it is important to provide adequate detail. That said, don't hesitate to edit out superfluous or ambiguous content that would confuse others.
  
  Additionally, if applicable, please do not include any data visualizations that will appear in the published article. For example, data figures and/or other supplementary material already present within the manuscript.
  
  
• Unprocessed and processed data: Providing both unprocessed and processed data can be valuable for re-analysis, assuming the data are of a reasonable size. Including unprocessed raw digital data from a recording instrument or database ensures that no details are lost, and any issues in the processing pipeline can be discovered and rectified. Processed data are cleaned, formatted, organized and ready for reuse by others.
  
  
• Code: Programming scripts communicate to others all of the steps in processing and analysis. Including them ensures that your results are reproducible by others. Informative comments throughout your code will help future users understand its logic.
  
  
• External resources: Links to associated data stored in other data repositories, code in software repositories, and associated publications can be included in "Related works".

Make sure your data are shareable

• All files submitted to Dryad must abide by the terms of the Creative Commons Zero (CC0 1.0) waiver. Under these terms, the author releases the data to the public domain.
  • Review all files and ensure they conform to CC0 terms and are not covered by copyright claims or other terms-of-use. We cannot archive any files that contain licenses incompatible with CC0 (GNU GPL, MIT, CC-BY, etc.), but we can link to content in a dedicated software repository (Github, Zenodo, Bitbucket, or CRAN, etc.).
  • For more information see Why Does Dryad Use CC0, and Some dos and don'ts for CC0.
• Human subjects data must be properly anonymized and prepared under applicable legal and ethical guidelines (see tips for human subjects data).
• If you work with vulnerable or endangered species, it may be necessary to mask location to prevent any further threat to the population. Please review our recommendations for responsibly sharing data collected from vulnerable species (see tips for endangered species data).

Make sure your data are accessible

• To maximize accessibility, reusability and preservability, share data in non-proprietary open formats when possible (see preferred formats). This ensures your data will be accessible by most people.
• Review files for errors. Common errors include missing data, misnamed files, mislabeled variables, incorrectly formatted values, and corrupted file archives. It may be helpful to run data validation tools before sharing. For example, if you are working with tabular datasets, a service like goodTables can identify missing data and data type formatting problems.
• Files compression may be necessary to reduce large file sizes or directories of files. Files can be bundled together in compressed file archives (.zip, .7z, .tar.gz). If you have a large directory of files, and there is a logical way to split it into subdirectories and compress those, we encourage you to do so. We recommend not exceeding 10GB each.

Preferred file formats

Dryad welcomes the submission of data in multiple formats to enable various reuse scenarios. For instance, Dryad's preferred format for tabular data is CSV, however, an Excel spreadsheet may optimize reuse in some cases. Thus, Dryad accepts more than just the preservation-friendly formats listed below.

• Text:
  • README files should be in plain text format (ASCII, UTF-8)
  • Comma-separated values (CSV) for tabular data
  • Semi-structured plain text formats for non-tabular data (e.g., protein sequences)
  • Structured plain text (XML, JSON)
• Images: PDF, JPEG, PNG, TIFF, SVG
• Audio: FLAC, AIFF, WAV, MP3, OGG
• Video: AVI, MPEG, MP4
• Compressed file archive: TAR.GZ, 7Z, ZIP

Organize files in a logical schema

File naming

Name files and directories in a consistent and descriptive manner. Avoid vague and ambiguous filenames. Filenames should be concise, informative, and unique (see Stanford's best practices for file naming).

Avoid blank spaces and special characters (' '!@#$%^&") in filenames because they can be problematic for computers to interpret. Use a common letter case pattern because they are easily read by both machines and people:

• Kebab-case: The-quick-brown-fox-jumps-over-the-lazy-dog.txt
• CamelCase: TheQuickBrownFoxJumpsOverTheLazyDog.txt
• Snake_case: The_quick_brown_fox_jumps_over_the_lazy_dog.txt

Include the following information when naming files:

• Author surname
• Date of study
• Project name
• Type of data or analysis
• File extension (.csv, .txt, .R, .xls, .tar.gz, etc.)

Examples

DatasetA.tar.gz
|- Data/
|  |- Processed/
|  |- Raw/
|- Results/
|  |- Figure1.tif
|  |- Figure2.tif
|  |- Models/
|- README.md

DatasetB.tar.gz
|- Figure1/
|  |- Data/
|  |- Results
|  |  |- Figure1.tif
|- Figure2/
|  |- Data/
|  |- Results/
|  |  |- Figure2.tif
|- README.md

Describe your dataset in a README file

Provide a clear and concise description of all components of your dataset in a README document. This will help others interpret and reanalyze your data.

We provide a README template in Markdown format to guide you through the creation of your README documentation.

If your dataset includes compressed archives, please upload your README externally as a stand-alone file in the 'Data' category so that users can view its contents before downloading the full dataset.

Details to include:

• Summary of experimental efforts underlying this dataset
• Description of file structure and contents
• Definitions of all variables, abbreviations, missing data codes, and units
• Links to other publicly accessible locations of the data
• Other sources, if any, that the data was derived from
• Any other details that may influence reuse or replication efforts

Ready to get started? Log in and go to the "My Datasets" to begin your data submission now!

Examples of good reusability practices

• Gallo T, Fidino M, Lehrer E, Magle S (2017) Data from: Mammal diversity and metacommunity dynamics in urban green spaces: implications for urban wildlife conservation. Dryad Digital Repository. https://doi.org/10.5061/dryad.9mf02
• Rajon E, Desouhant E, Chevalier M, Débias F, Menu F (2014) Data from: The evolution of bet hedging in response to local ecological conditions. Dryad Digital Repository. https://doi.org/10.5061/dryad.g7jq6
• Drake JM, Kaul RB, Alexander LW, O'Regan SM, Kramer AM, Pulliam JT, Ferrari MJ, Park AW (2015) Data from: Ebola cases and health system demand in Liberia. Dryad Digital Repository. https://doi.org/10.5061/dryad.17m5q
• Wall CB, Mason RAB, Ellis WR, Cunning R, Gates RD (2017) Data from: Elevated pCO2 affects tissue biomass composition, but not calcification, in a reef coral under two light regimes. Dryad Digital Repository. https://doi.org/10.5061/dryad.5vg70.3
• Kriebel R, Khabbazian M, Sytsma KJ (2017) Data from: A continuous morphological approach to study the evolution of pollen in a phylogenetic context: an example with the order Myrtales. Dryad Digital Repository. https://doi.org/10.5061/dryad.j17pm.2

Further resources

• Institutional data librarians are an outstanding resource. Check with your university library's data management services team.
• Cornell University Research Data Management Service Group's Guide to writing "readme" style metadata
• Why Dryad uses Creative Commons Zero
• DataONE Primer on Data Management Best Practices
• Introduction to Open Science: Why data versioning and data care practices are key for science and social science
• Making data Findable, Accessible, Interoperable, and Reusable (FAIR)
• goodTables - free online service for tabular data validation
• Data organization in spreadsheets