gecco: gecco.xml annotate

annotate gecco.xml @ 14:56b924f62165 draft

"Update tests files for Galaxy tool wrapper"

author	althonos
date	Tue, 05 Apr 2022 23:18:49 +0000
parents	d64fe390f3c9
children	cc91d730cc4f

rev	line source
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	1 <?xml version='1.0' encoding='utf-8'?>
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	2 <tool id="gecco" name="GECCO" version="0.9.1" python_template_version="3.5">
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	3 <description>is a fast and scalable method for identifying putative novel Biosynthetic Gene Clusters (BGCs) in genomic and metagenomic data using Conditional Random Fields (CRFs).</description>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	4 <requirements>
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	5 <requirement type="package" version="0.9.1">gecco</requirement>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	6 </requirements>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	7 <version_command>gecco --version</version_command>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	8 <command detect_errors="aggressive"><![CDATA[
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	9
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	10 #if str($input.ext) == 'genbank':
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	11 #set $file_extension = 'gbk'
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	12 #else:
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	13 #set $file_extension = $input.ext
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	14 #end if
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	15 ln -s '$input' input_tempfile.$file_extension &&
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	16
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	17 gecco -vv run
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	18 --format $input.ext
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	19 --genome input_tempfile.$file_extension
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	20 --postproc $postproc
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	21 --force-tsv
56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	22 #if $edge_distance
56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	23 --edge-distance $edge_distance
56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	24 #end if
9 d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	25 #if $mask
d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	26 --mask
d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	27 #end if
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	28 #if $cds:
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	29 --cds $cds
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	30 #end if
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	31 #if $threshold:
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	32 --threshold $threshold
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	33 #end if
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	34 #if $antismash_sideload:
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	35 --antismash-sideload
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	36 #end if
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	37
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	38 && mv input_tempfile.genes.tsv '$genes'
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	39 && mv input_tempfile.features.tsv '$features'
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	40 && mv input_tempfile.clusters.tsv '$clusters'
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	41 #if $antismash_sideload
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	42 && mv input_tempfile.sideload.json '$sideload'
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	43 #end if
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	44
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	45 ]]></command>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	46 <inputs>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	47 <param name="input" type="data" format="genbank,fasta,embl" label="Sequence file in GenBank, EMBL or FASTA format"/>
9 d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	48 <param argument="--mask" type="boolean" checked="false" label="Enable masking of regions with unknown nucleotides when finding ORFs"/>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	49 <param argument="--cds" type="integer" min="0" value="" optional="true" label="Minimum number of genes required for a cluster"/>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	50 <param argument="--threshold" type="float" min="0" max="1" value="" optional="true" label="Probability threshold for cluster detection"/>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	51 <param argument="--postproc" type="select" label="Post-processing method for gene cluster validation">
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	52 <option value="antismash">antiSMASH</option>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	53 <option value="gecco" selected="true">GECCO</option>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	54 </param>
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	55 <param argument="--edge-distance" type="integer" min="0" optional="true" value="" label="Number of genes from the contig edges to filter out"/>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	56 <param argument="--antismash-sideload" type="boolean" checked="false" label="Generate an antiSMASH v6 sideload JSON file"/>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	57 </inputs>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	58 <outputs>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	59 <collection name="records" type="list" label="${tool.name} detected Biosynthetic Gene Clusters on ${on_string} (GenBank)">
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	60 <discover_datasets pattern="(?P<designation>.*)\.gbk" ext="genbank" visible="false" />
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	61 </collection>
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	62 <data name="genes" format="tabular" label="${tool.name} summary of detected genes on ${on_string} (TSV)"/>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	63 <data name="features" format="tabular" label="${tool.name} summary of detected features on ${on_string} (TSV)"/>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	64 <data name="clusters" format="tabular" label="${tool.name} summary of detected BGCs on ${on_string} (TSV)"/>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	65 <data name="sideload" format="json" label="antiSMASH v6 sideload file with ${tool.name} detected BGCs on ${on_string} (JSON)">
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	66 <filter>antismash_sideload</filter>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	67 </data>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	68 </outputs>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	69 <tests>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	70 <test>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	71 <param name="input" value="BGC0001866.fna"/>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	72 <output name="features" file="features.tsv"/>
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	73 <output name="genes" file="genes.tsv"/>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	74 <output name="clusters" file="clusters.tsv"/>
9 d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	75 </test>
d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	76 <test>
d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	77 <param name="input" value="BGC0001866.fna"/>
d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	78 <param name="edge_distance" value="0"/>
d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	79 <output name="features" file="features.tsv"/>
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	80 <output name="genes" file="genes.tsv"/>
9 d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	81 <output name="clusters" file="clusters.tsv"/>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	82 <output_collection name="records" type="list">
4 88dc16b4f583 "Fix number of allowed different lines in `galaxy/gecco.xml` tests" althonos parents: 3 diff changeset	83 <element name="BGC0001866.1_cluster_1" file="BGC0001866.1_cluster_1.gbk" ftype="genbank" compare="diff" lines_diff="4"/>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	84 </output_collection>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	85 </test>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	86 <test>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	87 <param name="input" value="BGC0001866.fna"/>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	88 <param name="antismash_sideload" value="True"/>
9 d64fe390f3c9 "Fix test files used in Galaxy test workflow" althonos parents: 4 diff changeset	89 <param name="edge_distance" value="0"/>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	90 <output name="features" file="features.tsv"/>
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	91 <output name="genes" file="genes.tsv"/>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	92 <output name="clusters" file="clusters.tsv"/>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	93 <output name="sideload" file="sideload.json"/>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	94 <output_collection name="records" type="list">
4 88dc16b4f583 "Fix number of allowed different lines in `galaxy/gecco.xml` tests" althonos parents: 3 diff changeset	95 <element name="BGC0001866.1_cluster_1" file="BGC0001866.1_cluster_1.gbk" ftype="genbank" compare="diff" lines_diff="4"/>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	96 </output_collection>
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	97 </test>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	98 </tests>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	99 <help><![CDATA[
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	100
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	101 Overview
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	102 --------
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	103
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	104 GECCO (Gene Cluster prediction with Conditional Random Fields) is a fast and scalable method for identifying putative novel Biosynthetic Gene Clusters (BGCs) in genomic and metagenomic data using Conditional Random Fields (CRFs).
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	105 It is developed in the Zeller group and is part of the suite of computational microbiome analysis tools hosted at EMBL.
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	106
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	107 Input
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	108 -----
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	109
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	110 GECCO works with DNA sequences, and loads them using Biopython, allowing it to support a large variety of formats, including the common FASTA and GenBank files.
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	111
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	112 Output
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	113 ------
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	114
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	115 GECCO will create the following files once done (using the same prefix as the input file):
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	116
14 56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	117 - ``features.tsv``: The genes file, containing the genes identified in the input sequences.
56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	118 - ``features.tsv``: The features file, containing the protein domains identified in the input sequences.
56b924f62165 "Update tests files for Galaxy tool wrapper" althonos parents: 9 diff changeset	119 - ``clusters.tsv``: A clusters file, containing the coordinates of the predicted clusters, along their putative biosynthetic type.
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	120 - ``{sequence}_cluster_{N}.gbk``: If any BGCs were found, a GenBank file per cluster, containing the cluster sequence annotated with its member proteins and domains.
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	121
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	122 Contact
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	123 -------
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	124
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	125 If you have any question about GECCO, if you run into any issue, or if you would like to make a feature request, please create an issue in the
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	126 `GitHub repository <https://github.com/zellerlab/gecco>`_. You can also directly contact `Martin Larralde via email <mailto:martin.larralde@embl.de>`_.
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	127 If you want to contribute to GECCO, please have a look at the contribution guide first, and feel free to open a pull request on the GitHub repository.
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	128
359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	129 ]]></help>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	130 <citations>
3 359232b58f6a "Update Galaxy tool wrapper to follow the IUC best practices" althonos parents: 0 diff changeset	131 <citation type="doi">10.1101/2021.05.03.442509</citation>
0 1625927fc16f "Release v0.8.4" althonos parents: diff changeset	132 </citations>
1625927fc16f "Release v0.8.4" althonos parents: diff changeset	133 </tool>

Mercurial > repos > althonos > gecco

annotate gecco.xml @ 14:56b924f62165 draft