Mercurial > repos > rliterman > csp2

annotate csp2_snp.xml @ 56:c8ca27626fa9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload"
author rliterman
date Thu, 19 Dec 2024 10:56:32 -0500
parents 629a4fe7bb13
children c8dfcb29d91b
rev   line source
rliterman@29 1 <tool id="csp2-snp" name="CSP2 (SNP Pipeline Mode)" version="0.9.7_Dev21">
rliterman@29 2 <description>Run SNP Pipeline analysis on isolates using one or more references.</description>
rliterman@29 3 <requirements>
rliterman@29 4 <requirement type="package" version="24.10.1">nextflow</requirement>
rliterman@29 5 <requirement type="package" version="1.5.8">micromamba</requirement>
rliterman@29 6 </requirements>
rliterman@29 7 <version_command>nextflow -version</version_command>
rliterman@29 8 <command detect_errors="aggressive"><![CDATA[
rliterman@51 9 mkdir ./queries ./references;
rliterman@29 10
rliterman@55 11 if [[ "$query_fasta.query_fasta_select" == "none" ]]; then
rliterman@55 12 export QUERY_FASTA_ARG="";
rliterman@55 13 elif [[ "$query_fasta.query_fasta_select" == "history" ]]; then
rliterman@55 14 #for query in $query_fasta.list:
rliterman@55 15 ln -sf ${query} ./queries/${query.element_identifier};
rliterman@55 16 #end for
rliterman@51 17 export QUERY_FASTA_ARG="--fasta ./queries";
rliterman@29 18 else
rliterman@56 19 #for query in $query_fasta.coll.elements:
rliterman@55 20 ln -sf ${query} ./queries/${query.element_identifier};
rliterman@55 21 #end for
rliterman@55 22 export QUERY_FASTA_ARG="--fasta ./queries";
rliterman@29 23 fi;
rliterman@29 24
rliterman@55 25 if [[ "$ref_fasta.ref_fasta_select" == "none" ]]; then
rliterman@55 26 export REF_FASTA_ARG="";
rliterman@55 27 elif [[ "$ref_fasta.ref_fasta_select" == "history" ]]; then
rliterman@55 28 #for ref in $ref_fasta.list:
rliterman@55 29 ln -sf ${ref} ./references/${ref.element_identifier};
rliterman@55 30 #end for
rliterman@55 31 export REF_FASTA_ARG="--ref_fasta ./references";
rliterman@29 32 else
rliterman@56 33 #for ref in $ref_fasta.coll.elements:
rliterman@55 34 ln -sf ${ref} ./references/${ref.element_identifier};
rliterman@55 35 #end for
rliterman@55 36 export REF_FASTA_ARG="--ref_fasta ./references";
rliterman@29 37 fi;
rliterman@29 38
rliterman@55 39 if [[ "$query_reads.query_reads_select" == "none" ]]; then
rliterman@55 40 export QUERY_READS_ARG="";
rliterman@55 41 elif [[ "$query_reads.query_reads_select" == "history" ]]; then
rliterman@55 42 #for query in $query_reads.list:
rliterman@55 43 ln -sf ${query} ./queries/${query.element_identifier};
rliterman@55 44 #end for
rliterman@55 45 export QUERY_READS_ARG="--reads ./queries";
rliterman@29 46 else
rliterman@55 47 #for query in $query_reads.coll.forward:
rliterman@55 48 ln -sf ${query} ./queries/${query.element_identifier};
rliterman@55 49 #end for
rliterman@55 50 #for query in $query_reads.coll.reverse:
rliterman@55 51 ln -sf ${query} ./queries/${query.element_identifier};
rliterman@55 52 #end for
rliterman@55 53 export QUERY_READS_ARG="--reads ./queries";
rliterman@29 54 fi;
rliterman@29 55
rliterman@55 56 if [[ "$ref_reads.ref_reads_select" == "none" ]]; then
rliterman@55 57 export REF_READS_ARG="";
rliterman@55 58 elif [[ "$ref_reads.ref_reads_select" == "history" ]]; then
rliterman@55 59 #for ref in $ref_reads.list:
rliterman@55 60 ln -sf ${ref} ./references/${ref.element_identifier};
rliterman@55 61 #end for
rliterman@51 62 export REF_READS_ARG="--ref_reads ./references";
rliterman@29 63 else
rliterman@55 64 #for ref in $ref_reads.coll.forward:
rliterman@55 65 ln -sf ${ref} ./references/${ref.element_identifier};
rliterman@55 66 #end for
rliterman@55 67 #for ref in $ref_reads.coll.reverse:
rliterman@55 68 ln -sf ${ref} ./references/${ref.element_identifier};
rliterman@55 69 #end for
rliterman@55 70 export REF_READS_ARG="--ref_reads ./references";
rliterman@29 71 fi;
rliterman@29 72
rliterman@55 73 if [[ "$trim_name" != "DUMMYCSP2TRIM" ]]; then
rliterman@29 74 export TRIM_ARG="--trim_name $trim_name";
rliterman@29 75 else
rliterman@29 76 export TRIM_ARG="";
rliterman@29 77 fi;
rliterman@29 78
rliterman@29 79 if [[ "$rescue" == "true" ]]; then
rliterman@29 80 export RESCUE_ARG="--rescue";
rliterman@29 81 else
rliterman@29 82 export RESCUE_ARG="";
rliterman@29 83 fi;
rliterman@29 84
rliterman@52 85 nextflow run ${__tool_directory__}/CSP2/CSP2.nf -profile csp2_galaxy --runmode snp \$QUERY_FASTA_ARG \$REF_FASTA_ARG \$QUERY_READS_ARG \$REF_READS_ARG \$TRIM_ARG \$RESCUE_ARG --readext $readext --forward $forward --reverse $reverse --ref_readext $readext --ref_forward $forward --ref_reverse $reverse --min_cov $min_cov --min_iden $min_iden --min_len $min_len --ref_edge $ref_edge --query_edge $query_edge --dwin $dwin --wsnps $wsnps --max_missing $max_missing --n_ref $n_ref --out ./CSP2_SNP_Output > Nextflow_Log.txt 2>&1 &&
rliterman@51 86 mkdir CSP2_Output &&
rliterman@51 87 cat CSP2_SNP_Output/logs/Reference_IDs.txt | while read line; do cp 'CSP2_SNP_Output/SNP_Analysis/'\$line'/CSP2_SNP_Pipeline.log' 'CSP2_Output/'\$line'_CSP2_SNP_Pipeline.log'; cp 'CSP2_SNP_Output/SNP_Analysis/'\$line'/Reference_Screening.tsv' 'CSP2_Output/'\$line'_Reference_Screening.tsv'; cp 'CSP2_SNP_Output/SNP_Analysis/'\$line'/snp_distance_matrix_preserved.tsv' 'CSP2_Output/'\$line'_snp_distance_matrix_preserved.tsv'; cp 'CSP2_SNP_Output/SNP_Analysis/'\$line'/snp_distance_pairwise_preserved.tsv' 'CSP2_Output/'\$line'_snp_distance_pairwise_preserved.tsv'; cp 'CSP2_SNP_Output/SNP_Analysis/'\$line'/snpma_preserved.fasta' 'CSP2_Output/'\$line'_snpma_preserved.fasta';done &&
rliterman@51 88 ls -la CSP2_Output;
rliterman@33 89
rliterman@34 90 ]]>
rliterman@29 91 </command>
rliterman@29 92 <inputs>
rliterman@55 93 <conditional name="query_fasta">
rliterman@55 94 <param name="query_fasta_select" type="select" label="Get query assemblies from a collection or your history">
rliterman@55 95 <option value="none" selected="true">Do not provide query assemblies</option>
rliterman@55 96 <option value="collection">Query assemblies from a collection_type</option>
rliterman@55 97 <option value="history">Query assemblies from your history</option>
rliterman@55 98 </param>
rliterman@55 99 <when value="none">
rliterman@55 100 </when>
rliterman@55 101 <when value="collection">
rliterman@55 102 <param label="Query Assembly Collection" name="coll" type="data_collection" format="fasta" collection_type="list" />
rliterman@55 103 </when>
rliterman@55 104 <when value="history">
rliterman@55 105 <param label="Query Assembly List" type="data" name="list" format="fasta" multiple="true" />
rliterman@55 106 </when>
rliterman@55 107 </conditional>
rliterman@55 108
rliterman@55 109 <conditional name="ref_fasta">
rliterman@55 110 <param name="ref_fasta_select" type="select" label="Get reference assemblies from a collection or your history">
rliterman@55 111 <option value="none" selected="true">Do not provide reference assemblies</option>
rliterman@55 112 <option value="collection">Reference assemblies from a collection_type</option>
rliterman@55 113 <option value="history">Reference assemblies from your history</option>
rliterman@55 114 </param>
rliterman@55 115 <when value="none">
rliterman@55 116 </when>
rliterman@55 117 <when value="collection">
rliterman@55 118 <param label="Reference Assembly Collection" name="coll" type="data_collection" format="fasta" collection_type="list" />
rliterman@55 119 </when>
rliterman@55 120 <when value="history">
rliterman@55 121 <param label="Reference Assembly List" type="data" name="list" format="fasta" multiple="true" />
rliterman@55 122 </when>
rliterman@55 123 </conditional>
rliterman@55 124 <conditional name="query_reads">
rliterman@55 125 <param name="query_reads_select" type="select" label="Get query reads from a paired-end collection or your history">
rliterman@55 126 <option value="none" selected="true">Do not provide query reads</option>
rliterman@55 127 <option value="collection">Query reads from a collection_type</option>
rliterman@55 128 <option value="history">Query reads from your history</option>
rliterman@55 129 </param>
rliterman@55 130 <when value="none">
rliterman@55 131 </when>
rliterman@55 132 <when value="collection">
rliterman@55 133 <param label="Query Reads Collection" name="coll" type="data_collection" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" collection_type="paired" />
rliterman@55 134 </when>
rliterman@55 135 <when value="history">
rliterman@55 136 <param label="Query Reads List" type="data" name="list" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" multiple="true" />
rliterman@55 137 </when>
rliterman@55 138 </conditional>
rliterman@55 139
rliterman@55 140 <conditional name="ref_reads">
rliterman@55 141 <param name="ref_reads_select" type="select" label="Get reference reads from a paired-end collection or your history">
rliterman@55 142 <option value="none" selected="true">Do not provide reference reads</option>
rliterman@55 143 <option value="collection">Refrence reads from a collection_type</option>
rliterman@55 144 <option value="history">Refrence reads from your history</option>
rliterman@55 145 </param>
rliterman@55 146 <when value="none">
rliterman@55 147 </when>
rliterman@55 148 <when value="collection">
rliterman@55 149 <param label="Refrence Reads Collection" name="coll" type="data_collection" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" collection_type="paired" />
rliterman@55 150 </when>
rliterman@55 151 <when value="history">
rliterman@55 152 <param label="Refrence Reads List" type="data" name="list" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" multiple="true" />
rliterman@55 153 </when>
rliterman@55 154 </conditional>
rliterman@55 155
rliterman@29 156 <param name="min_cov" type="float" value="85" label="Minimum reference genome coverage to proceed with distance estimation" optional="true" />
rliterman@29 157 <param name="min_iden" type="float" value="99" label="Minimum alignment percent identity to detect SNPs" optional="true" />
rliterman@29 158 <param name="min_len" type="integer" value="500" label="Minimum alignment length to detect SNPs" optional="true" />
rliterman@29 159 <param name="ref_edge" type="integer" value="150" label="Prune SNPs within this many bases of reference contig edge" optional="true" />
rliterman@29 160 <param name="query_edge" type="integer" value="150" label="Prune SNPs within this many bases of query contig edge" optional="true" />
rliterman@29 161 <param name="dwin" type="text" value="1000,125,15" label="Comma-separated set of window sizes for SNP density filtration (Set to 0 to disable density filtration)" optional="true" />
rliterman@29 162 <param name="wsnps" type="text" value="3,2,1" label="Comma-separated list of maximum SNP counts per density window" optional="true" />
rliterman@29 163 <param name="readext" type="text" value="fastq.gz" label="Read extension format (e.g., fastq.gz)" optional="true" />
rliterman@29 164 <param name="forward" type="text" value="_1.fastq.gz" label="Forward read suffix (e.g. _1.fastq.gz)" optional="true" />
rliterman@29 165 <param name="reverse" type="text" value="_2.fastq.gz" label="Forward read suffix (e.g. _2.fastq.gz)" optional="true" />
rliterman@55 166 <param name="trim_name" type="text" value="DUMMYCSP2TRIM" label="Text to remove from all file names (e.g., _contigs_skesa)" optional="true" />
rliterman@29 167 <param name="rescue" type="boolean" value="false" label="Enable SNP edge rescue mode" optional="true" />
rliterman@29 168 <param name="max_missing" type="float" value="50" label="Maximum percent of isolates allowed to have missing data to retain a SNP" optional="true" />
rliterman@52 169 <param name="n_ref" type="integer" value="1" label="Number of reference genomes to select" optional="true" />
rliterman@52 170
rliterman@29 171 </inputs>
rliterman@29 172 <outputs>
rliterman@34 173 <data name="isolate_data" format="tabular" label="Isolate Data" from_work_dir="CSP2_SNP_Output/Isolate_Data.tsv" />
rliterman@29 174 <data name="raw_mummer" format="tabular" label="Raw MUMmer Output" from_work_dir="CSP2_SNP_Output/Raw_MUMmer_Summary.tsv" />
rliterman@51 175
rliterman@51 176 <collection name="csp2_logs" type='list' label="CSP2 Log">
rliterman@51 177 <discover_datasets pattern="(?P&lt;designation&gt;.+)_CSP2_SNP_Pipeline\.log" directory="CSP2_Output" format='txt'/>
rliterman@51 178 </collection>
rliterman@51 179 <collection name="csp2_alignments" type='list' label="CSP2 Alignment">
rliterman@51 180 <discover_datasets pattern="(?P&lt;designation&gt;.+)_snpma_preserved\.fasta" directory="CSP2_Output" format='fasta'/>
rliterman@51 181 </collection>
rliterman@51 182 <collection name="csp2_matrices" type='list' label="CSP2 Matrices">
rliterman@51 183 <discover_datasets pattern="(?P&lt;designation&gt;.+)_snp_distance_matrix_preserved\.tsv" directory="CSP2_Output" format='tabular'/>
rliterman@51 184 </collection>
rliterman@51 185 <collection name="csp2_pairwise" type='list' label="CSP2 Pairwise Distances">
rliterman@51 186 <discover_datasets pattern="(?P&lt;designation&gt;.+)_snp_distance_pairwise_preserved\.tsv" directory="CSP2_Output" format='tabular'/>
rliterman@51 187 </collection>
rliterman@51 188 <collection name="csp2_ref_screening" type='list' label="CSP2 Reference Screening">
rliterman@51 189 <discover_datasets pattern="(?P&lt;designation&gt;.+)_Reference_Screening\.tsv" directory="CSP2_Output" format='tabular'/>
rliterman@37 190 </collection>
rliterman@29 191 </outputs>
rliterman@29 192 <tests>
rliterman@29 193 <test>
rliterman@29 194 <param name="query_fasta">
rliterman@29 195 <collection type="list">
rliterman@29 196 <element name="Sample_A" value="assemblies/Sample_A.fasta" />
rliterman@29 197 <element name="Sample_B" value="assemblies/Sample_B.fasta" />
rliterman@29 198 <element name="Sample_C" value="assemblies/Sample_C.fasta" />
rliterman@29 199 <element name="Sample_D" value="assemblies/Sample_D.fasta" />
rliterman@29 200 <element name="Sample_E" value="assemblies/Sample_E.fasta" />
rliterman@29 201 <element name="Sample_F" value="assemblies/Sample_F.fasta" />
rliterman@29 202 <element name="Sample_G" value="assemblies/Sample_G.fasta" />
rliterman@29 203 <element name="Sample_H" value="assemblies/Sample_H.fasta" />
rliterman@29 204 <element name="Sample_I" value="assemblies/Sample_I.fasta" />
rliterman@29 205 <element name="Sample_J" value="assemblies/Sample_J.fasta" />
rliterman@29 206 <element name="Sample_K" value="assemblies/Sample_K.fasta" />
rliterman@29 207 <element name="Sample_L" value="assemblies/Sample_L.fasta" />
rliterman@29 208 <element name="Sample_M" value="assemblies/Sample_M.fasta" />
rliterman@29 209 <element name="Sample_N" value="assemblies/Sample_N.fasta" />
rliterman@29 210 <element name="Sample_O" value="assemblies/Sample_O.fasta" />
rliterman@29 211 </collection>
rliterman@29 212 </param>
rliterman@29 213 <param name="query_reads">
rliterman@29 214 <collection type="list">
rliterman@29 215 <element name="Forward" value="reads/Week_42_Reads_1.fq.gz" />
rliterman@29 216 <element name="Reverse" value="reads/Week_42_Reads_2.fq.gz" />
rliterman@29 217 </collection>
rliterman@29 218 </param>
rliterman@29 219
rliterman@29 220 <param name="ref_id" value="Sample_A,Sample_B" />
rliterman@29 221 <param name="readext" value="fq.gz" />
rliterman@29 222 <param name="forward" value="_1.fq.gz" />
rliterman@29 223 <param name="reverse" value="_2.fq.gz" />
rliterman@29 224
rliterman@29 225 <output name="isolate_data" value="Isolate_Data.tsv" />
rliterman@29 226 </test>
rliterman@29 227 </tests>
rliterman@29 228 <help>
rliterman@29 229 This tool takes query assemblies and reference assemblies and calculates the pairwise distance between each query/reference combination. If no reference is provided, all queries are compared to all other queries.
rliterman@29 230 </help>
rliterman@29 231 <citations>
rliterman@29 232 <citation type="doi">10.XXXX/placeholder.doi</citation>
rliterman@29 233 <citation type="bibtex">@article{example2024,title={CFSAN SNP Pipeline 2 (CSP2): a pipeline for fast and accurate SNP distance estimation from bacterial genome assemblies.},author={Doe, John and Smith, Jane},journal={Submitted},year={2024}}
rliterman@29 234 </citation>
rliterman@29 235 </citations>
rliterman@29 236 </tool>
rliterman@29 237