Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Final publish extended #54

Merged
merged 9 commits into from
Dec 6, 2024
Merged

Conversation

maxulysse
Copy link
Member

@maxulysse maxulysse commented Dec 5, 2024

Complement #53

Idea is:

1 genome build can have more than a single gff.

ie Human GRCh38.
The fasta is the same, but the gff is more and more refined, so the indexes of the aligners that depends on this gff are now stored in a dedicated folder.

Any alternate proposal?

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/references branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@maxulysse
Copy link
Member Author

I'm thinking it would be better to add source_gff as metadata in the assets.
But the publishing makes more sense this way

tests/hisat2.nf.test.snap Outdated Show resolved Hide resolved
Copy link

@adamrtalbot adamrtalbot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should try and pre-populate the source GFF field, rather than using a custom string. That way, we can get the source_gff for free, no user interaction required.

Still, not blocking. This is a nice feature to add later.

Comment on lines +138 to +140
meta.source_gff == "unknown"
? "${meta.species}/${meta.source}/${meta.id}/Sequence/Hisat2Index/version2.2.1"
: "${meta.species}/${meta.source}/${meta.id}/Sequence/Hisat2Index/${meta.source_gff}/version2.2.1"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the pipeline, do you add the name of the GFF to the meta map? This way we get this field populated by default:

meta = meta + [ "source_gff": ${gff.simpleName} ]

@maxulysse maxulysse merged commit b692521 into nf-core:dev Dec 6, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants