-
Notifications
You must be signed in to change notification settings - Fork 22
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
[Do not merge!] Pseudo PR for first release #69
base: first-commit-for-pseudo-pr
Are you sure you want to change the base?
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.
Overall looks pretty good, main things are:
- Add license to ALL scripts in
bin/
(particularly for the package) - Make sure all version numbers are defined for all tools in the
conda
declaration of local modules with mulled containers,and these are exported.
workflows/circrna.nf
Outdated
ch_multiqc_files = ch_multiqc_files.mix(ch_workflow_summary.collectFile(name: 'workflow_summary_mqc.yaml')) | ||
ch_multiqc_files = ch_multiqc_files.mix(ch_methods_description.collectFile(name: 'methods_description_mqc.yaml')) | ||
ch_multiqc_files = ch_multiqc_files.mix(CUSTOM_DUMPSOFTWAREVERSIONS.out.mqc_yml.collect()) | ||
ch_multiqc_files = ch_multiqc_files.mix(FASTQC_TRIMGALORE.out.fastqc_zip.collect{it[1]}.ifEmpty([])) |
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.
Is it correct only FastQC goes into MultiQC?
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.
I'll look into generating BAM stats
README.md
Outdated
|
||
**workflow for the quantification, differential expression analysis and miRNA target prediction analysis of circRNAs in RNA-Seq data**. | ||
[![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?labelColor=000000&logo=Amazon%20AWS)](https://nf-co.re/circrna/results)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.XXXXXXX-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.XXXXXXX) |
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.
README.md
Outdated
4. circRNA annotation | ||
5. Export mature spliced length as FASTA file | ||
6. Annotate parent gene, underlying transcripts. | ||
7. circRNA count matrix |
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.
Are these the custom R scripts? Otherwise maybe also link the tools here in a similar fashion to above
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.
Nope, vanilla python and bash.
section_name: "nf-core/circrna Methods Description" | ||
section_href: "https://github.com/nf-core/circrna" | ||
plot_type: "html" | ||
## TODO nf-core: Update the HTML below to your prefered methods description, e.g. add publication citation for this pipeline |
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.
you might want to add your paper here
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.
I'll give it a go! I went to the Sarek one to copy but... ;)
bin/ensembl_database_map.txt
Outdated
@@ -0,0 +1,18 @@ | |||
species command | |||
cel useMart(biomart = "ensembl", dataset = "celegans_gene_ensembl", host="https://www.ensembl.org", archive=FALSE) |
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.
This fetches the newest version every time, right? I am a bit worried about reproducibility and compatibility in the long run. Would there be a way to cache it?
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.
Think I'll deprecate this code, its only going to cause trouble
} | ||
} | ||
|
||
// PREPARE GENOME |
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.
I suspect you will get WARN messages if the indices already exist
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.
I'll test this. I have a hard time resolving WARN messages
conf/modules.config
Outdated
|
||
// PREPARE GENOME | ||
withName: BOWTIE_BUILD { | ||
ext.when = { params.fasta && !params.bowtie && params.tool.split(',').contains('mapsplice') && params.module.split(',').contains('circrna_discovery') } |
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.
what happens if params.tools doesn't exist? Or does it always have to have a value?
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.
similar for params.module
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.
must have a value, a la --tool 'mutect2'
, --step 'mapping'
..
conf/test_full.config
Outdated
// Input data for full size test | ||
// TODO nf-core: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA) | ||
// TODO nf-core: Give any required params for the test so that command line flags are not needed | ||
input = 'https://raw.githubusercontent.com/nf-core/test-datasets/viralrecon/samplesheet/samplesheet_full_illumina_amplicon.csv' |
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.
is this the right input?
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.
nope, I was hoping for some help in getting my full test dataset up and running.
@@ -1,63 +1,590 @@ | |||
# nf-core/circrna: Output | |||
|
|||
## :warning: Please read this documentation on the nf-core website: [https://nf-co.re/circrna/output](https://nf-co.re/circrna/output) |
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.
is this line removed in the template @jfy133 ?
Implement ciriquant quantification
Add parameter for grouping detected circRNAs that are very close
Versioning
Important! Template update for nf-core/tools v3.0.2
Do not merge! This is a PR of dev compared to first release for whole-pipeline reviewing purposes.
Comments can be copied over to #66 for safety if necessary and changes made there. Changes should be made to
dev
and this PR should not be merged intofirst-commit-for-pseudo-pr
!