Mercurial > repos > rliterman > csp2

annotate csp_screen.xml @ 25:5c609acba34e

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