Repository navigation
New module: fairbioheaders/combine - #13492
Draft
adamjohnwright wants to merge 1 commit into
Draft
adamjohnwright wants to merge 1 commit into
adamjohnwright wants to merge 1 commit into
Conversation
Add FAIRBIOHEADERS_COMBINE, which wraps `bioheaders combine` from the fair-bioheaders toolkit (Bioconda) to attach FAIR-bioHeaders provenance metadata (FHR, FHP or FHGFF3) to a FASTA, protein FASTA, GFA or GFF3 file and record the file's checksum in the header. The header type comes from the metadata's schema URL and names the output; compressed input gives BGZF output. Generated by Claude Code Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
4 tasks done
|
This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size. |
5 of 10 tasks
Author
|
On the size warning: this is one module. 1,955 of the 2,721 added lines are the two generated |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
fairbioheaders/combine, which wrapsbioheaders combinefrom fair-bioheaders. It validates FAIR-bioHeaders provenance metadata against its schema, attaches it to a FASTA, protein FASTA, GFA or GFF3 file as a header, and records the SHA-512/256 checksum of the result in the header. Headers: FHR for genome FASTA and GFA, FHP for protein FASTA and FHGFF3 for GFF3 (doi:10.1093/bib/bbae122).Motivation: nf-core/genomeassembler#250 adds an optional FHR export of assembly outputs (nf-core/genomeassembler#242), and the review there asked for it to use nf-core modules. This is the step that PR relies on most. Follow-up PRs will add
fairbioheaders/verify,fairbioheaders/convertandfairbioheaders/validate.Input:
[ meta, metadata (JSON/YAML), sequence ], where the sequence is plain, gzip or BGZF.Outputs:
fasta:<prefix>.fhr.fastaor<prefix>.fhp.fastagfa:<prefix>.fhr.gfagff3:<prefix>.fhgff3.gff3.gz(BGZF) when the input was compressedtopic: versionsNotes for reviewers:
fair-bioheaders=0.8.5(MPL-2.0, bio.toolsfair-bioheaders). Containers were built withnf-core modules containers create(Seqera, linux/amd64 and linux/arm64). About 1,950 of the added lines are the two generated.conda-lockfiles.bioheaders --versionprints a bare version (0.8.5), emitted viatopic: versions.prefixare single-quoted in the script, and--comes before positional arguments, because sample IDs in assembly pipelines can contain spaces, quotes or a leading-(tested by hand withit's $xand-dash). Happy to drop this if reviewers prefer the plainer style.collectFile, so no test-datasets PR is needed; I can move it to test-datasets if preferred.<prefix>.<fasta|gfa|gff3>[.gz]and lets the tool name the output<stem>.<fhr|fhp|fhgff3>.<type>. That is why there are three optional typed output channels. A run produces exactly one of them, and the tests assert which one..gzand.bgzhandled). The task also fails, with the tool's exit code, on:AI assistance: the module was prepared with Claude Code (Claude Opus 5.5), which also ran an adversarial review. I have reviewed the code, the tests and the snapshots, and I will handle review comments.
Generated by Claude Code
PR checklist
Part of #13491 (first of four fairbioheaders modules).
topic: versions- See version_topicslabelnf-core modules test <MODULE> --profile dockernf-core modules test <MODULE> --profile singularity(not run locally; the Seqera Singularity image was pulled and smoke-tested by hand)nf-core modules test <MODULE> --profile conda🤖 Generated with Claude Code