×

Nextflow Modules

Clear

Showing module(s) with keyword "fair"

Module Kind Keywords Description
nf-core/fairbioheaders/combine Process fasta gfa gff3 genome assembly metadata provenance fair checksum Attach FAIR-bioHeaders provenance metadata (FHR, FHP or FHGFF3) to a FASTA, protein FASTA, GFA or GFF3 file as a header, after validating the metadata against its schema, and record the SHA-512/256 checksum of the result in the header. The output keeps the extension of the input (`<prefix>.<extension>`), and compressed input gives BGZF-compressed output. The task fails when the metadata is invalid, when the header type does not suit the file type (for example FHP on GFA), when the file extension is not one the tool supports, or when the output name would overwrite the input; set `ext.prefix` in that case.
nf-core/fairbioheaders/convert Process metadata provenance fair conversion json yaml json-ld Convert FAIR-bioHeaders metadata (FHR, FHP or FHGFF3) to JSON, YAML, JSON-LD or HTML, for example to extract the header of a FASTA, GFA or GFF3 file written by fairbioheaders/combine as a sidecar YAML file that carries the file's checksum. The metadata is validated against its schema; the task fails when it is invalid, when a sequence file has no header, or when the output name would overwrite the input (choose a different `ext.prefix` in that case). The output is named `<prefix>.<format>`, where the prefix defaults to `<meta.id>_converted`. FHGFF3 metadata cannot be written as JSON-LD or HTML.
nf-core/fairbioheaders/validate Process metadata provenance fair validation schema json yaml Validate standalone FAIR-bioHeaders metadata (FHR, FHP or FHGFF3, as JSON, YAML or JSON-LD) against the schema its schema URL selects, without a sequence file, for example to check user-supplied metadata before a long run. The task fails when the metadata does not validate or cites a schema version the toolkit does not bundle. Use fairbioheaders/verify for a FASTA, GFA or GFF3 file that carries a header.
nf-core/fairbioheaders/verify Process fasta gfa gff3 metadata provenance fair checksum validation Verify the FAIR-bioHeaders header (FHR, FHP or FHGFF3) of a FASTA, protein FASTA, GFA or GFF3 file: validate the header against its schema and check that the SHA-512/256 checksum it records matches the file. The task fails when the file has no header, the header is invalid or the checksum does not match, so a failed check cannot pass unnoticed.