-
Notifications
You must be signed in to change notification settings - Fork 3
Port of Prepare-metadata to new module 'metadata/genomesummary' #23
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of minor details, but looks good otherwise 👍 Cheers!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the LICENSE, I know you're not following nf-core standards but personally I would follow something like this for licenses just so that you have a total separation of text and code.
That would be great if we could, unfortunately Apache license requires a LICENSE and NOTICE file in the root of the repo, and then a boilerplate header inside each file [link]. And thankfully now we have the NOTICE with the copyright year, before the year was in every header, terribly painful to update every year. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shame about the license, everything else looks good to me though!
This is the first piece of the puzzle in splitting the current Ensembl/Genomio module Prepare_metadata.nf.
In the current form, we have a non-standard module comprised of essentially A) Subworkflow, B) module process and C) Function to index the metadata returned from module process. As a request, moving this module to nextflow_modules will require this to be split entirely into distinct parts.
This PR contains part B) - Just the module process ('_PREPARE_GENOME_METADATA') and calling of ensembl-genomio python module
genome_metadata_prepare
which generates one output metadata JSON. Included also software version JSONs as part of nf-core standard practice.MID PR Update required:
I have made an effort to be as descriptive as possible in terms of the naming of this tool/subtool. Originally I went with
metadata/fetch
but realised the module is doing some very particular metadata parsing from a genome summary JSON file from NCBI. Hence this name could be a bit misleading. I made update to the meta YML to give further information. Name of the module (i.e. tool/subtool) PLUS the meta YML should suffice in directing users who want to adopt a given module.Included also: