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

Release PR for 2.1.0 #197

Merged
merged 179 commits into from
Oct 24, 2022
Merged

Release PR for 2.1.0 #197

merged 179 commits into from
Oct 24, 2022

Conversation

apeltzer
Copy link
Member

PR for upcoming release 2.1.0

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/smrnaseq branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile 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).

Christian Kubica and others added 30 commits April 28, 2022 11:54
Add parameters to allow the use of MirGeneDB as database in the smranseq
pipeline. The paths to the files are still temporary.
Added a if statement to assign the new mature and hairpin fasta files
if MirGeneDB is to be used in the analysis.
Added the option to use the mirGeneDB species to parse the fasta files
as different styles in species naming result in mis-parsed files.
Commit of the latest testing changes
Enable the use of the mirGeneDB gff file in the mirtop analysis and
replace the mirna_gtf file with it internally.
Added a new variable that either takes the mirGeneDB or the mirtrace species
to filter the fasta files.
Add the new options and their description to the schema.
Moved the devinition of the filterSpecies variable to the smrnaseq
workflow instead of the individual modules.
Added the decoumentation of new parameters and features to the appropriate
files.
This commit adds three modules to filter conatminants from the smRNA-Seq data.
Using databses provided by the user the reads are filtered for rrna, trna, cdna,
ncrna, and pirna. The provided files are filtered to remove miRNAs, indexed
and used as reference to map the reads to using bowtie2. Reads that map to a
contaminant database are removed from the sample.

The process is optional and only those contaminants will be filtered for which
a reference database has been provided.
Adds a workflow to run the contamination filtering processes
introduced by an earlier commit.
Adds the contamination filtering subworkflow into the existing
pipeline.
The added process collects the contamination filtering statistics
and combines them to be added to the MultiQC output.
Added the FILTER_STATS step and the necessary alterations to hand
over the data to the new process.
Enables the process to access all required stats files of each
sample for processing.
Removed the appended filter tags and changed the naming of the
individual stats files to be better accessible downstream
Altered the statistics output to be in line with the format for
custom multiQC plots. In addition the number of remaining reads
is now included in the statistics.
Changed the output file name and adjusted the awk output to be readable
by multiQC.
Added an additional filter step that can be used to filter with a
custom database in addition to the other databases.
Added the contamination filtering statistics to the multiqc output.
Added the options and default settings to filter contamination
from the supplied sequence files. By default contamination filtering
is disabled.
Added the new options to the nextflow_schema.
Changed the output of the contamination step to be gzipped.
Moved the enabeling command for contaminaition filtering to the
top of hte section.
@apeltzer apeltzer requested review from JoseEspinosa and a team October 20, 2022 08:02
@github-actions
Copy link

github-actions bot commented Oct 20, 2022

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 5f84f21

+| ✅ 156 tests passed       |+
!| ❗   2 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: '2.1.0'
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your prefered methods description, e.g. add publication citation for this pipeline

✅ Tests passed:

Run details

  • nf-core/tools version 2.6
  • Run at 2022-10-24 22:24:06

@apeltzer apeltzer requested a review from robsyme October 20, 2022 16:05
Copy link
Member

@JoseEspinosa JoseEspinosa left a comment

Choose a reason for hiding this comment

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

Appart from some minor suggestions looks awesome! 🚀

README.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
modules/local/blat_mirna.nf Outdated Show resolved Hide resolved
modules/local/filter_stats.nf Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
subworkflows/local/contaminant_filter.nf Outdated Show resolved Hide resolved
apeltzer and others added 6 commits October 24, 2022 12:47
Co-authored-by: Jose Espinosa-Carrasco <kadomu@gmail.com>
Co-authored-by: Jose Espinosa-Carrasco <kadomu@gmail.com>
Co-authored-by: Jose Espinosa-Carrasco <kadomu@gmail.com>
Joses comments resolved for release
Copy link
Contributor

@edmundmiller edmundmiller left a comment

Choose a reason for hiding this comment

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

Nothing major, just some nits!

CHANGELOG.md Outdated Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
modules/local/bowtie_map_contaminants.nf Outdated Show resolved Hide resolved
modules/local/filter_stats.nf Show resolved Hide resolved
nextflow.config Show resolved Hide resolved
subworkflows/local/contaminant_filter.nf Outdated Show resolved Hide resolved
subworkflows/local/contaminant_filter.nf Outdated Show resolved Hide resolved
subworkflows/local/contaminant_filter.nf Outdated Show resolved Hide resolved
apeltzer and others added 7 commits October 25, 2022 00:10
Co-authored-by: Edmund Miller <edmund.a.miller@gmail.com>
Co-authored-by: Edmund Miller <edmund.a.miller@gmail.com>
Co-authored-by: Edmund Miller <edmund.a.miller@gmail.com>
Shameless self merge as this is only reviewers comments :-)
Copy link
Contributor

@robsyme robsyme left a comment

Choose a reason for hiding this comment

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

Short and sweet!

@apeltzer apeltzer merged commit 83fe0b6 into master Oct 24, 2022
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.

7 participants