Research Object Crate
The key words “MUST”, “MUST NOT”, “SHOULD”, etc. are to be interpreted as described in RFC 2119.
All nf-core pipelines MUST come with their own Research Object (RO) Crate.
Rationale
RO Crate is an open-source standard which we use to describe our pipelines and their components in a structured way and helps with automated provenance tracking.
Note
The RO Crate generated with nf-core/tools describes the pipeline as a whole, not pipeline runs. For that kind of provenance, use the new nf-prov plugin, which is currently in development.
More information can be found here.
- Get started
- Running
- Overview
- Advanced topics
- Configuration
- Reference genomes
- Running pipelines offline
- Developing
- Overview
- Containers
- Documentation
- Institutional profiles
- Migration guides
- Testing
- Contributing
- Overview
- Components
- Contribution types
- Contributor's list
- Deprecating modules
- Documentation
- Existing pipelines
- New pipelines
- Project proposals
- Reviewing pull requests
- nf-core bot
- Review checklists
- Reviewing pipeline releases
- Specifications
- Community
- Advisories
- Governance
- Terminology
- nf-core/tools
- API
- CLI
- Installation
- Test datasets
- TUI