Skip to content

Commit

Permalink
updated refs to new name
Browse files Browse the repository at this point in the history
  • Loading branch information
mattheww95 committed Mar 25, 2024
1 parent 816063c commit bc07e5a
Show file tree
Hide file tree
Showing 24 changed files with 153 additions and 55 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# phac-nml/iridanextexample: Changelog
# phac-nml/gasnomenclature: Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Expand All @@ -23,7 +23,7 @@ Allowing non-gzipped FASTQ files as input. Default branch is now main.

## 1.0.0 - 2023/11/30

Initial release of phac-nml/iridanextexample, created with the [nf-core](https://nf-co.re/) template.
Initial release of phac-nml/gasnomenclature, created with the [nf-core](https://nf-co.re/) template.

### `Added`

Expand Down
2 changes: 1 addition & 1 deletion CITATIONS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# phac-nml/iridanextexample: Citations
# phac-nml/gasnomenclature: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Other parameters (defaults from nf-core) are defined in [nextflow_schema.json](n
To run the pipeline, please do:

```bash
nextflow run phac-nml/iridanextexample -profile singularity -r main -latest --input assets/samplesheet.csv --outdir results
nextflow run phac-nml/gasnomenclature -profile singularity -r main -latest --input assets/samplesheet.csv --outdir results
```

Where the `samplesheet.csv` is structured as specified in the [Input](#input) section.
Expand Down Expand Up @@ -90,7 +90,7 @@ There is also a pipeline execution summary output file provided (specified in th
To run with the test profile, please do:

```bash
nextflow run phac-nml/iridanextexample -profile docker,test -r main -latest --outdir results
nextflow run phac-nml/gasnomenclature -profile docker,test -r main -latest --outdir results
```

# Legal
Expand Down
2 changes: 1 addition & 1 deletion assets/adaptivecard.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"size": "Large",
"weight": "Bolder",
"color": "<% if (success) { %>Good<% } else { %>Attention<%} %>",
"text": "phac-nml/iridanextexample v${version} - ${runName}",
"text": "phac-nml/gasnomenclature v${version} - ${runName}",
"wrap": true
},
{
Expand Down
14 changes: 7 additions & 7 deletions assets/email_template.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

<meta name="description" content="phac-nml/iridanextexample: Example IRIDA Next pipeline">
<title>phac-nml/iridanextexample Pipeline Report</title>
<meta name="description" content="phac-nml/gasnomenclature: Example IRIDA Next pipeline">
<title>phac-nml/gasnomenclature Pipeline Report</title>
</head>
<body>
<div style="font-family: Helvetica, Arial, sans-serif; padding: 30px; max-width: 800px; margin: 0 auto;">

<img src="cid:nfcorepipelinelogo">

<h1>phac-nml/iridanextexample v${version}</h1>
<h1>phac-nml/gasnomenclature v${version}</h1>
<h2>Run Name: $runName</h2>

<% if (!success){
out << """
<div style="color: #a94442; background-color: #f2dede; border-color: #ebccd1; padding: 15px; margin-bottom: 20px; border: 1px solid transparent; border-radius: 4px;">
<h4 style="margin-top:0; color: inherit;">phac-nml/iridanextexample execution completed unsuccessfully!</h4>
<h4 style="margin-top:0; color: inherit;">phac-nml/gasnomenclature execution completed unsuccessfully!</h4>
<p>The exit status of the task that caused the workflow execution to fail was: <code>$exitStatus</code>.</p>
<p>The full error message was:</p>
<pre style="white-space: pre-wrap; overflow: visible; margin-bottom: 0;">${errorReport}</pre>
Expand All @@ -27,7 +27,7 @@ <h4 style="margin-top:0; color: inherit;">phac-nml/iridanextexample execution co
} else {
out << """
<div style="color: #3c763d; background-color: #dff0d8; border-color: #d6e9c6; padding: 15px; margin-bottom: 20px; border: 1px solid transparent; border-radius: 4px;">
phac-nml/iridanextexample execution completed successfully!
phac-nml/gasnomenclature execution completed successfully!
</div>
"""
}
Expand All @@ -44,8 +44,8 @@ <h3>Pipeline Configuration:</h3>
</tbody>
</table>

<p>phac-nml/iridanextexample</p>
<p><a href="https://github.com/phac-nml/iridanextexample">https://github.com/phac-nml/iridanextexample</a></p>
<p>phac-nml/gasnomenclature</p>
<p><a href="https://github.com/phac-nml/gasnomenclature">https://github.com/phac-nml/gasnomenclature</a></p>

</div>

Expand Down
10 changes: 5 additions & 5 deletions assets/email_template.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
|\\ | |__ __ / ` / \\ |__) |__ } {
| \\| | \\__, \\__/ | \\ |___ \\`-._,-`-,
`._,._,'
phac-nml/iridanextexample v${version}
phac-nml/gasnomenclature v${version}
----------------------------------------------------
Run Name: $runName

<% if (success){
out << "## phac-nml/iridanextexample execution completed successfully! ##"
out << "## phac-nml/gasnomenclature execution completed successfully! ##"
} else {
out << """####################################################
## phac-nml/iridanextexample execution completed unsuccessfully! ##
## phac-nml/gasnomenclature execution completed unsuccessfully! ##
####################################################
The exit status of the task that caused the workflow execution to fail was: $exitStatus.
The full error message was:
Expand All @@ -35,5 +35,5 @@ Pipeline Configuration:
<% out << summary.collect{ k,v -> " - $k: $v" }.join("\n") %>

--
phac-nml/iridanextexample
https://github.com/phac-nml/iridanextexample
phac-nml/gasnomenclature
https://github.com/phac-nml/gasnomenclature
6 changes: 3 additions & 3 deletions assets/methods_description_template.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
id: "nf-core-iridanext-methods-description"
description: "Suggested text and references to use when describing pipeline usage within the methods section of a publication."
section_name: "phac-nml/iridanextexample Methods Description"
section_href: "https://github.com/phac-nml/iridanextexample"
section_name: "phac-nml/gasnomenclature Methods Description"
section_href: "https://github.com/phac-nml/gasnomenclature"
plot_type: "html"
data: |
<h4>Methods</h4>
<p>Data was processed using phac-nml/iridanextexample v${workflow.manifest.version} ${doi_text} of the nf-core collection of workflows (<a href="https://doi.org/10.1038/s41587-020-0439-x">Ewels <em>et al.</em>, 2020</a>), utilising reproducible software environments from the Bioconda (<a href="https://doi.org/10.1038/s41592-018-0046-7">Grüning <em>et al.</em>, 2018</a>) and Biocontainers (<a href="https://doi.org/10.1093/bioinformatics/btx192">da Veiga Leprevost <em>et al.</em>, 2017</a>) projects.</p>
<p>Data was processed using phac-nml/gasnomenclature v${workflow.manifest.version} ${doi_text} of the nf-core collection of workflows (<a href="https://doi.org/10.1038/s41587-020-0439-x">Ewels <em>et al.</em>, 2020</a>), utilising reproducible software environments from the Bioconda (<a href="https://doi.org/10.1038/s41592-018-0046-7">Grüning <em>et al.</em>, 2018</a>) and Biocontainers (<a href="https://doi.org/10.1093/bioinformatics/btx192">da Veiga Leprevost <em>et al.</em>, 2017</a>) projects.</p>
<p>The pipeline was executed with Nextflow v${workflow.nextflow.version} (<a href="https://doi.org/10.1038/nbt.3820">Di Tommaso <em>et al.</em>, 2017</a>) with the following command:</p>
<pre><code>${workflow.commandLine}</code></pre>
<p>${tool_citations}</p>
Expand Down
8 changes: 4 additions & 4 deletions assets/multiqc_config.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
report_comment: >
This report has been generated by the <a href="https://github.com/phac-nml/iridanextexample/releases/tag/dev" target="_blank">phac-nml/iridanextexample</a>
This report has been generated by the <a href="https://github.com/phac-nml/gasnomenclature/releases/tag/dev" target="_blank">phac-nml/gasnomenclature</a>
analysis pipeline. For information about how to interpret these results, please see the
<a href="https://github.com/phac-nml/iridanextexample/" target="_blank">documentation</a>.
<a href="https://github.com/phac-nml/gasnomenclature/" target="_blank">documentation</a>.
report_section_order:
"phac-nml-iridanextexample-methods-description":
"phac-nml-gasnomenclature-methods-description":
order: -1000
software_versions:
order: -1001
"phac-nml-iridanextexample-summary":
"phac-nml-gasnomenclature-summary":
order: -1002

export_plots: true
4 changes: 2 additions & 2 deletions assets/schema_input.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/phac-nml/iridanextexample/main/assets/schema_input.json",
"title": "phac-nml/iridanextexample pipeline - params.input schema",
"$id": "https://raw.githubusercontent.com/phac-nml/gasnomenclature/main/assets/schema_input.json",
"title": "phac-nml/gasnomenclature pipeline - params.input schema",
"description": "Schema for the file provided with params.input",
"type": "array",
"items": {
Expand Down
2 changes: 1 addition & 1 deletion assets/slackreport.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"fallback": "Plain-text summary of the attachment.",
"color": "<% if (success) { %>good<% } else { %>danger<%} %>",
"author_name": "phac-nml/iridanextexample v${version} - ${runName}",
"author_name": "phac-nml/gasnomenclature v${version} - ${runName}",
"author_icon": "https://www.nextflow.io/docs/latest/_static/favicon.ico",
"text": "<% if (success) { %>Pipeline completed successfully!<% } else { %>Pipeline completed with errors<% } %>",
"fields": [
Expand Down
2 changes: 1 addition & 1 deletion conf/base.config
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
phac-nml/iridanextexample Nextflow base config file
phac-nml/gasnomenclature Nextflow base config file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A 'blank slate' config file, appropriate for general use on most high performance
compute environments. Assumes that all software is installed and available on
Expand Down
4 changes: 2 additions & 2 deletions conf/test.config
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Defines input files and everything required to run a fast and simple pipeline test.
Use as follows:
nextflow run phac-nml/iridanextexample -profile test,<docker/singularity> --outdir <OUTDIR>
nextflow run phac-nml/gasnomenclature -profile test,<docker/singularity> --outdir <OUTDIR>
----------------------------------------------------------------------------------------
*/
Expand All @@ -20,5 +20,5 @@ params {
max_time = '1.h'

// Input data
input = 'https://raw.githubusercontent.com/phac-nml/iridanextexample/main/assets/samplesheet.csv'
input = 'https://raw.githubusercontent.com/phac-nml/gasnomenclature/main/assets/samplesheet.csv'
}
4 changes: 2 additions & 2 deletions conf/test_full.config
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Defines input files and everything required to run a full size pipeline test.
Use as follows:
nextflow run phac-nml/iridanextexample -profile test_full,<docker/singularity> --outdir <OUTDIR>
nextflow run phac-nml/gasnomenclature -profile test_full,<docker/singularity> --outdir <OUTDIR>
----------------------------------------------------------------------------------------
*/
Expand All @@ -15,5 +15,5 @@ params {
config_profile_description = 'Full test dataset to check pipeline function'

// Input data for full size test
input = 'https://raw.githubusercontent.com/phac-nml/iridanextexample/main/assets/samplesheet.csv'
input = 'https://raw.githubusercontent.com/phac-nml/gasnomenclature/main/assets/samplesheet.csv'
}
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# phac-nml/iridanextexample: Documentation
# phac-nml/gasnomenclature: Documentation

The phac-nml/iridanextexample documentation is split into the following pages:
The phac-nml/gasnomenclature documentation is split into the following pages:

- [Usage](usage.md)
- An overview of how the pipeline works, how to run it and a description of all of the different command-line flags.
Expand Down
2 changes: 1 addition & 1 deletion docs/output.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# phac-nml/iridanextexample: Output
# phac-nml/gasnomenclature: Output

## Introduction

Expand Down
2 changes: 1 addition & 1 deletion docs/run-wes-example.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@
"engine": "nextflow",
"execute_loc": "azure"
},
"workflow_url": "https://github.com/phac-nml/iridanextexample",
"workflow_url": "https://github.com/phac-nml/gasnomenclature",
"workflow_attachment": ""
}
6 changes: 3 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# phac-nml/iridanextexample: Usage
# phac-nml/gasnomenclature: Usage

## Introduction

Expand Down Expand Up @@ -62,7 +62,7 @@ Do not use `-c <file>` to specify parameters as this will result in errors. Cust
The above pipeline run specified with a params file in yaml format:

```bash
nextflow run phac-nml/iridanextexample -profile docker -params-file params.yaml
nextflow run phac-nml/gasnomenclature -profile docker -params-file params.yaml
```

with `params.yaml` containing:
Expand All @@ -79,7 +79,7 @@ You can also generate such `YAML`/`JSON` files via [nf-core/launch](https://nf-c

It is a good idea to specify a pipeline version when running the pipeline on your data. This ensures that a specific version of the pipeline code and software are used when you run your pipeline. If you keep using the same tag, you'll be running the same version of the pipeline, even if there have been changes to the code since.

First, go to the [phac-nml/iridanextexample page](https://github.com/phac-nml/iridanextexample) and find the latest pipeline version - numeric only (eg. `1.3.1`). Then specify this when running the pipeline with `-r` (one hyphen) - eg. `-r 1.3.1`. Of course, you can switch to another version by changing the number after the `-r` flag.
First, go to the [phac-nml/gasnomenclature page](https://github.com/phac-nml/gasnomenclature) and find the latest pipeline version - numeric only (eg. `1.3.1`). Then specify this when running the pipeline with `-r` (one hyphen) - eg. `-r 1.3.1`. Of course, you can switch to another version by changing the number after the `-r` flag.

This version number will be logged in reports when you run the pipeline, so that you'll know what you used when you look back in the future.

Expand Down
8 changes: 4 additions & 4 deletions main.nf
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/usr/bin/env nextflow
/*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
phac-nml/iridanextexample
phac-nml/gasnomenclature
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Github : https://github.com/phac-nml/iridanextexample
Github : https://github.com/phac-nml/gasnomenclature
----------------------------------------------------------------------------------------
*/

Expand Down Expand Up @@ -39,10 +39,10 @@ WorkflowMain.initialise(workflow, params, log, args)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/

include { IRIDANEXT } from './workflows/iridanextexample'
include { IRIDANEXT } from './workflows/gasnomenclature'

//
// WORKFLOW: Run main phac-nml/iridanextexample analysis pipeline
// WORKFLOW: Run main phac-nml/gasnomenclature analysis pipeline
//
workflow PHACNML_IRIDANEXT {
IRIDANEXT ()
Expand Down
4 changes: 2 additions & 2 deletions modules.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "phac-nml/iridanextexample",
"homePage": "https://github.com/phac-nml/iridanextexample",
"name": "phac-nml/gasnomenclature",
"homePage": "https://github.com/phac-nml/gasnomenclature",
"repos": {
"https://github.com/nf-core/modules.git": {
"modules": {
Expand Down
37 changes: 37 additions & 0 deletions modules/local/gas/call/main.nf
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@


process GAS_CALL{
label "process_high"
tag "Calling: ${meta.id}"

container "${ workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container ?
'https://depot.galaxyproject.org/singularity/genomic_address_service%3A0.1.1--pyh7cba7a3_1' :
'quay.io/biocontainers/genomic_address_service:0.1.1--pyh7cba7a3_1' }"


input:
tuple val(meta), path(reference_clusters), path(distances)

output:
tuple val(meta), path("${prefix}/results.{text,parquet}"), emit: distances, optional: true
tuple val(meta), path("${prefix}/thresholds.json"), emit: thresholds
tuple val(meta), path("${prefix}/run.json"), emit: run
path "versions.yml", emit: versions

script:
// Need to add more args for gas call below
prefix = meta.id
"""
gas call --dists $distances \\
--rclusters $reference_clusters \\
--outdir ${prefix} \\
--threshold ${params.gm_thresholds} \\
--delimeter ${params.gm_delimiter}
cat <<-END_VERSIONS > versions.yml
"${task.process}":
genomic_address_service: \$( gas call -V | sed -e "s/gas//g" )
END_VERSIONS
"""

}
61 changes: 61 additions & 0 deletions modules/local/profile_dists/main.nf
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
process PROFILE_DISTS{
label "process_high"
tag "Pairwise Distance Generation: ${meta.id}"

container "${ workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container ?
'https://depot.galaxyproject.org/singularity/profile_dists%3A1.0.0--pyh7cba7a3_0' :
'quay.io/biocontainers/profile_dists:1.0.0--pyh7cba7a3_0' }"

input:
tuple val(meta), path(query), path(ref)
val mapping_format
path(mapping_file)
path(columns)


output:
tuple val(meta), path("${prefix}_${mapping_format}/allele_map.json"), emit: allele_map
tuple val(meta), path("${prefix}_${mapping_format}/query_profile.{text,parquet}"), emit: query_profile
tuple val(meta), path("${prefix}_${mapping_format}/ref_profile.{text,parquet}"), emit: ref_profile
tuple val(meta), path("${prefix}_${mapping_format}/results.{text,parquet}"), emit: results
tuple val(meta), path("${prefix}_${mapping_format}/run.json"), emit: run
path "versions.yml", emit: versions


script:
def args = ""

if(mapping_file){
args = args + "--mapping_file $mapping_file"
}
if(columns){
args = args + " --columns $columns"
}
if(params.pd_force){
args = args + " --force"
}
if(params.pd_skip){
args = args + " --skip"
}
if(params.pd_count_missing){
args = args + " --count_missing"
}
// --match_threshold $params.profile_dists.match_thresh \\
prefix = meta.id
"""
profile_dists --query $query --ref $ref $args --outfmt $mapping_format \\
--distm $params.pd_distm \\
--file_type $params.pd_file_type \\
--missing_thresh $params.pd_missing_threshold \\
--sample_qual_thresh $params.pd_sample_quality_threshold \\
--max_mem ${task.memory.toGiga()} \\
--cpus ${task.cpus} \\
-o ${prefix}_${mapping_format}
cat <<-END_VERSIONS > versions.yml
"${task.process}":
profile_dists: \$( profile_dists -V | sed -e "s/profile_dists//g" )
END_VERSIONS
"""

}
Loading

0 comments on commit bc07e5a

Please sign in to comment.