annotate csp2-screen.xml @ 0:01431fa12065

"planemo upload"
author rliterman
date Mon, 02 Dec 2024 10:40:55 -0500
parents
children
rev   line source
rliterman@0 1 <tool id="csp2-screen" name="CSP2 (Screening Mode)" version="0.9.7">
rliterman@0 2 <description>Screen query assemblies against reference assemblies</description>
rliterman@0 3 <requirements>
rliterman@0 4 <requirement type="package" version="24.10.1">nextflow</requirement>
rliterman@0 5 <requirement type="package" version="2.0.2">micromamba</requirement>
rliterman@0 6 </requirements>
rliterman@0 7 <command detect_errors="aggressive"><![CDATA[
rliterman@0 8 export CSP2_DIR=\$PWD;
rliterman@0 9 mkdir -p \$CSP2_DIR/queries \$CSP2_DIR/references;
rliterman@0 10
rliterman@0 11 if [ -n "$query_fasta" ] && [ "$query_fasta" != "None" ]; then
rliterman@0 12 #for query in $query_fasta:
rliterman@0 13 ln -sf ${query} \$CSP2_DIR/queries/${query.element_identifier};
rliterman@0 14 #end for
rliterman@0 15 export QUERY_FASTA_ARG="--fasta \$CSP2_DIR/queries";
rliterman@0 16 else
rliterman@0 17 export QUERY_FASTA_ARG="";
rliterman@0 18 fi;
rliterman@0 19
rliterman@0 20 if [ -n "$query_reads" ] && [ "$query_reads" != "None" ]; then
rliterman@0 21 #for query in $query_reads:
rliterman@0 22 ln -sf ${query} \$CSP2_DIR/queries/${query.element_identifier};
rliterman@0 23 #end for
rliterman@0 24 export QUERY_READS_ARG="--reads \$CSP2_DIR/queries";
rliterman@0 25 else
rliterman@0 26 export QUERY_READS_ARG="";
rliterman@0 27 fi;
rliterman@0 28
rliterman@0 29 if [ -n "$ref_fasta" ] && [ "$ref_fasta" != "None" ]; then
rliterman@0 30 #for ref in $ref_fasta:
rliterman@0 31 ln -sf ${ref} \$CSP2_DIR/references/${ref.element_identifier};
rliterman@0 32 #end for
rliterman@0 33 export REF_FASTA_ARG="--ref_fasta \$CSP2_DIR/references";
rliterman@0 34 else
rliterman@0 35 export REF_FASTA_ARG="";
rliterman@0 36 fi;
rliterman@0 37
rliterman@0 38 if [ -n "$ref_reads" ] && [ "$ref_reads" != "None" ]; then
rliterman@0 39 #for ref in $ref_reads:
rliterman@0 40 ln -sf ${ref} \$CSP2_DIR/references/${ref.element_identifier};
rliterman@0 41 #end for
rliterman@0 42 export REF_READS_ARG="--ref_reads \$CSP2_DIR/references";
rliterman@0 43 else
rliterman@0 44 export REF_READS_ARG="";
rliterman@0 45 fi;
rliterman@0 46
rliterman@0 47 if [ -n "$trim_name" ] && [ "$trim_name" != "None" ]; then
rliterman@0 48 export TRIM_ARG="--trim_name $trim_name";
rliterman@0 49 else
rliterman@0 50 export TRIM_ARG="";
rliterman@0 51 fi;
rliterman@0 52
rliterman@0 53 if [ -n "$ref_id" ] && [ "$ref_id" != "None" ]; then
rliterman@0 54 export REF_ID_ARG="--ref_id $ref_id";
rliterman@0 55 else
rliterman@0 56 export REF_ID_ARG="";
rliterman@0 57 fi;
rliterman@0 58
rliterman@0 59 nextflow run ${__tool_directory__}/CSP2/CSP2.nf -profile csp2_galaxy --runmode screen \$QUERY_FASTA_ARG \$REF_FASTA_ARG \$QUERY_READS_ARG \$REF_READS_ARG \$REF_ID_ARG \$TRIM_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 --cores 8 --out \$CSP2_DIR/CSP2_Screen_Output;
rliterman@0 60 ]]>
rliterman@0 61 </command>
rliterman@0 62 <inputs>
rliterman@0 63 <param name="query_fasta" type="data" format="fasta" value="" label="Query assemblies" multiple="true" optional="true" />
rliterman@0 64 <param name="ref_fasta" type="data" format="fasta" value="" label="Reference assemblies" multiple="true" optional="true" />
rliterman@0 65 <param name="query_reads" type="data" format="fastq,fastq.gz" value="" label="Query reads" multiple="true" optional="true" />
rliterman@0 66 <param name="ref_reads" type="data" format="fastq,fastq.gz" value="" label="Reference reads" multiple="true" optional="true" />
rliterman@0 67 <param name="min_cov" type="float" value="85" label="Minimum reference genome coverage to proceed with distance estimation" optional="true" />
rliterman@0 68 <param name="min_iden" type="float" value="99" label="Minimum alignment percent identity to detect SNPs" optional="true" />
rliterman@0 69 <param name="min_len" type="integer" value="500" label="Minimum alignment length to detect SNPs" optional="true" />
rliterman@0 70 <param name="ref_edge" type="integer" value="150" label="Prune SNPs within this many bases of reference contig edge" optional="true" />
rliterman@0 71 <param name="query_edge" type="integer" value="150" label="Prune SNPs within this many bases of query contig edge" optional="true" />
rliterman@0 72 <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@0 73 <param name="wsnps" type="text" value="3,2,1" label="Comma-separated list of maximum SNP counts per density window" optional="true" />
rliterman@0 74 <param name="readext" type="text" value="fastq.gz" label="Read extension format (e.g., fastq.gz)" optional="true" />
rliterman@0 75 <param name="forward" type="text" value="_1.fastq.gz" label="Forward read suffix (e.g. _1.fastq.gz)" optional="true" />
rliterman@0 76 <param name="reverse" type="text" value="_2.fastq.gz" label="Forward read suffix (e.g. _2.fastq.gz)" optional="true" />
rliterman@0 77 <param name="trim_name" type="text" value="" label="Text to remove from all file names (e.g., _contigs_skesa)" optional="true" />
rliterman@0 78 <param name="ref_id" type="text" value="" label="Comma-separated list of desired Reference IDs (e.g., Sample_A,Sample_B)" optional="true" />
rliterman@0 79 </inputs>
rliterman@0 80 <outputs>
rliterman@0 81 <data name="screening_results" format="tabular" label="Screening Results" from_work_dir="CSP2_Screen_Output/Screening_Results.tsv" />
rliterman@0 82 <data name="isolate_data" format="tabular" label="Isolate Data" from_work_dir="CSP2_Screen_Output/Isolate_Data.tsv" />
rliterman@0 83 </outputs>
rliterman@0 84 <tests>
rliterman@0 85 <test>
rliterman@0 86 <param name="query_fasta">
rliterman@0 87 <collection type="list">
rliterman@0 88 <element name="Sample_A" value="assemblies/Sample_A.fasta" />
rliterman@0 89 <element name="Sample_B" value="assemblies/Sample_B.fasta" />
rliterman@0 90 <element name="Sample_C" value="assemblies/Sample_C.fasta" />
rliterman@0 91 <element name="Sample_D" value="assemblies/Sample_D.fasta" />
rliterman@0 92 <element name="Sample_E" value="assemblies/Sample_E.fasta" />
rliterman@0 93 <element name="Sample_F" value="assemblies/Sample_F.fasta" />
rliterman@0 94 <element name="Sample_G" value="assemblies/Sample_G.fasta" />
rliterman@0 95 <element name="Sample_H" value="assemblies/Sample_H.fasta" />
rliterman@0 96 <element name="Sample_I" value="assemblies/Sample_I.fasta" />
rliterman@0 97 <element name="Sample_J" value="assemblies/Sample_J.fasta" />
rliterman@0 98 <element name="Sample_K" value="assemblies/Sample_K.fasta" />
rliterman@0 99 <element name="Sample_L" value="assemblies/Sample_L.fasta" />
rliterman@0 100 <element name="Sample_M" value="assemblies/Sample_M.fasta" />
rliterman@0 101 <element name="Sample_N" value="assemblies/Sample_N.fasta" />
rliterman@0 102 <element name="Sample_O" value="assemblies/Sample_O.fasta" />
rliterman@0 103 </collection>
rliterman@0 104 </param>
rliterman@0 105 <param name="query_reads">
rliterman@0 106 <collection type="list">
rliterman@0 107 <element name="Forward" value="reads/Week_42_Reads_1.fq.gz" />
rliterman@0 108 <element name="Reverse" value="reads/Week_42_Reads_2.fq.gz" />
rliterman@0 109 </collection>
rliterman@0 110 </param>
rliterman@0 111 <param name="ref_id" value="Sample_A,Sample_B" />
rliterman@0 112 <param name="readext" value="fq.gz" />
rliterman@0 113 <param name="forward" value="_1.fq.gz" />
rliterman@0 114 <param name="reverse" value="_2.fq.gz" />
rliterman@0 115 <output name="screening_results" value="Screening_Results.tsv" />
rliterman@0 116 <output name="isolate_data" value="Isolate_Data.tsv" />
rliterman@0 117 </test>
rliterman@0 118 </tests>
rliterman@0 119 <help>
rliterman@0 120 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@0 121 </help>
rliterman@0 122 <citations>
rliterman@0 123 <citation type="doi">10.XXXX/placeholder.doi</citation>
rliterman@0 124 <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@0 125 </citation>
rliterman@0 126 </citations>
rliterman@0 127 </tool>