14 Standards
Note
These are living standards. Have a question/concern/suggestion? Let’s chat.
Standards for each repository type …
In order to keep the standards easily digestable, for each repo type below we keep each standard short and simple and link out to other sections of the book for more information.
14.1 R
Each R package in WILDS should follow the following standards:
- Use package
pkgdownto create package documentation (see Section 8.1) - Use an open source license; in most cases that means MIT (see Section 10.1.1)
- Follow our package versioning guidelines (see Section 10.2)
- Follow our package releases guidelines (see Section 10.4)
- Follow all conventions in Chapter 13
14.2 Python
Each Python package in WILDS should follow the following standards:
- Maintain package documentation (see Section 8.2)
- Use an open source license; in most cases that means MIT (see Section 10.1.2)
- Follow our package versioning guidelines (see Section 10.2)
- Follow our package releases guidelines (see Section 10.4)
- Follow all conventions in Chapter 13
14.3 Docker
Each Docker container in WILDS should follow the following standards:
- Maintain necessary labels within the Dockerfile (see Section 12.2)
- Use an open source license; in most cases that means MIT (see Section 10.1.4)
- Keep containers as minimal and specific as possible (see Section 12.1)
- Follow all conventions in Chapter 12
14.4 Research Compendia
Coming soon!
14.5 WDL
Each WDL workflow in WILDS should follow the following standards:
- Maintain package documentation in the README of the repository at a minimum
- Use an open source license; in most cases that means MIT (see Section 10.1.3)
- Follow our package versioning guidelines (see Section 10.2)
- Follow all conventions in Chapter 11
14.6 NextFlow
Coming soon!
14.7 Compliance with standards
We’re not sure how this will be done exactly. For now, we’ll do compliance manually. Ideally the end state will be completely automated.