readme¶
- PipelineLint.readme()¶
Repository
README.mdtestsThe
README.mdfiles for a project are very important and must meet some requirements:Nextflow badge
If no Nextflow badge is found, a warning is given
If a badge is found but the version doesn’t match the minimum version in the config file, the test fails
Example badge code:
[](https://www.nextflow.io/)
Bioconda badge
If your pipeline contains a file called
environment.ymlin the root directory, a bioconda badge is requiredRequired badge code:
[](https://bioconda.github.io/)
Note
These badges are a markdown image
inside a markdown link[markdown image](<link URL>), so a bit fiddly to write.