[REVISION] Chapter: [1 Code] #103
Description
What guide are you proposing revisions for?
- EML Best Practices guide
- Dataset Design For Special Cases
- Domain Specific Guides
Chapter and Revision Information
Chapter Number: 1
Chapter Title: Code
Current Version/Commit: Version 2 prerelease
File Path: guide-special-cases/code.qmd
Reviewer(s): Suzanne Remillard, Tim Whiteaker (GC), Mary Martin, Risa McNellis
Review Date: 2025-09-08
Revision overview
The technical details are fine, but the intro and considerations sections need reworking to make things clearer.
Introduction
Reword the second paragraph to start with EDI. As it currently reads, it's like EDI is an afterthought.
In the third paragraph, de-emphasize the software tree. We aren't recommending it since tools for populating it are less common, and tools that do something useful with a populated software tree are also less common.
Considerations...
Start with a decision tree. It should include things like:
- If it's a script that helped process code, archive with the data package at EDI.
- Perhaps provide some tips on how to decide if code is worth archiving.
- If you are using a PASTA client as your data catalog and you want the code package to show up, archive it in EDI.
- If your code is already in GitHub and the above bullets don't apply, make a GitHub release and publish in Zenodo.
- Otherwise, do what works best for you.
- Always include a codemeta file.
External software
If you're citing software in the methods tree, you could also use citation elements in literatureCited.