Mercurial > repos > kkonganti > lexmapr2_from_cfsan

annotate cfsan_lexmapr2.xml @ 2:328a5cff4d10

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload"
author kkonganti
date Thu, 15 Sep 2022 12:57:33 -0400
parents 6fc05c435932
children c56b568f3dde
rev   line source
kkonganti@0 1 <tool id="cfsan_lexmapr2" name="Lexmapr2" version="2.0+galaxy0">
kkonganti@0 2 <description>A Lexicon and Rule-Based Tool for Translating Short Biomedical Specimen Descriptions into Semantic Web Ontology Terms</description>
kkonganti@0 3 <requirements>
kkonganti@0 4 <requirement type="package" version="3.7">python</requirement>
kkonganti@0 5 <requirement type="package">python-dateutil</requirement>
kkonganti@0 6 <requirement type="package">inflection</requirement>
kkonganti@0 7 <requirement type="package">matplotlib</requirement>
kkonganti@0 8 <requirement type="package">pandas</requirement>
kkonganti@0 9 <requirement type="package">nltk</requirement>
kkonganti@0 10 <requirement type="package">requests</requirement>
kkonganti@0 11 <requirement type="package">seaborn</requirement>
kkonganti@0 12 <requirement type="package">pygraphviz</requirement>
kkonganti@0 13 </requirements>
kkonganti@0 14 <version_command>python $__tool_directory__/lexmapr2.py --version</version_command>
kkonganti@0 15 <command detect_errors="exit_code"><![CDATA[
kkonganti@0 16 python $__tool_directory__/lexmapr2.py
kkonganti@0 17 #if ($embl_ont != ""):
kkonganti@0 18 -e $embl_ont
kkonganti@0 19 #end if
kkonganti@0 20 $no_ancestors
kkonganti@0 21 $bins
kkonganti@0 22 $full
kkonganti@0 23 $graph
kkonganti@1 24 #if $input_json.json_is_set
kkonganti@1 25 -u "$input_json.upload"
kkonganti@1 26 #end if
kkonganti@1 27 $input
kkonganti@0 28 ]]></command>
kkonganti@0 29 <environment_variables>
kkonganti@0 30 <environment_variable name="NLTK_DATA">/tool/tool-data/cfsan_lexmapr2/0/nltk_data</environment_variable>
kkonganti@0 31 </environment_variables>
kkonganti@0 32 <inputs>
kkonganti@0 33 <param name="input" type="data" format="csv" label="Input CSV"
kkonganti@0 34 help="First row should be a header and first column should be sample names" />
kkonganti@2 35 <param name="embl_ont" type="text" optional="true"
kkonganti@2 36 label="User defined comma-separated EMBL Ontology short names" />
kkonganti@1 37 <conditional name="input_json">
kkonganti@1 38 <param name="json_is_set" type="boolean" label="Use User defined bins in JSON format?" />
kkonganti@1 39 <when value="true">
kkonganti@1 40 <param name="upload" type="data" format="json" label="User defined bins" />
kkonganti@1 41 </when>
kkonganti@1 42 <when value="false">
kkonganti@1 43 </when>
kkonganti@1 44 </conditional>
kkonganti@0 45 <param name="bins" truevalue="-b" type="boolean" checked="true"
kkonganti@0 46 label="Classify samples into default bins" help="Default: true"/>
kkonganti@0 47 <param name="graph" truevalue="-g" type="boolean" checked="true"
kkonganti@0 48 label="Visualize summary of mapping and binning" help="Default: true"/>
kkonganti@0 49 <param name="full" truevalue="-f" type="boolean" checked="false"
kkonganti@0 50 label="Generate full output format" help="Default: false"/>
kkonganti@0 51 <param name="no_ancestors" truevalue="-a" type="boolean" checked="false"
kkonganti@0 52 label="Remove ancestral terms from output" help="Default: false"/>
kkonganti@0 53 </inputs>
kkonganti@0 54 <outputs>
kkonganti@0 55 <data name="lexmapr2_output" format="tsv" label="Lexmapr2: On ${on_string}" from_work_dir="lexmapr2_output.tsv"/>
kkonganti@0 56 <collection name="plots" type="list" label="Lexmapr2: Plots on ${on_string}">
kkonganti@0 57 <discover_datasets pattern=".*\.png" ext="png" directory="lexmapr_figures"/>
kkonganti@0 58 </collection>
kkonganti@0 59 </outputs>
kkonganti@0 60 <tests>
kkonganti@0 61 <test expect_num_outputs="2">
kkonganti@0 62 <param name="input" value="test.csv"/>
kkonganti@0 63 </test>
kkonganti@0 64 </tests>
kkonganti@0 65 <help><![CDATA[
kkonganti@0 66
kkonganti@0 67 .. class:: infomark
kkonganti@0 68
kkonganti@0 69 **Purpose**
kkonganti@0 70
kkonganti@0 71 Lexmapr2 is a fork of Lexmapr (https://github.com/cidgoh/LexMapr) with the following added functionalitites:
kkonganti@0 72
kkonganti@0 73 ::
kkonganti@0 74
kkonganti@0 75 - pull ontology accession ids and definitions from EMBL-EBI via the API
kkonganti@0 76 - group mapped results by parent ontologies
kkonganti@0 77 - visualize mapping results
kkonganti@0 78
kkonganti@0 79 ----
kkonganti@0 80
kkonganti@0 81 .. class:: infomark
kkonganti@0 82
kkonganti@0 83 **Customization**
kkonganti@0 84
kkonganti@0 85 By default, the FOODON and NCBITaxon ontologies are used. Users can define a comma-delimited list of ontology short names (https://www.ebi.ac.uk/ols/ontologies) flagged with '-e'. Bins are used to categorize matched ontologies by their parent ontologies. Users can override the default bins by flagging a JSON file with the '-u' option.
kkonganti@0 86
kkonganti@0 87 Example JSON format to use a bin titled 'ncbi_taxon':
kkonganti@0 88
kkonganti@0 89 ::
kkonganti@0 90
kkonganti@0 91 {
kkonganti@0 92 "ncbi_taxon":{
kkonganti@0 93 "Actinopterygii":"NCBITaxon_7898",
kkonganti@0 94 "Ecdysozoa":"NCBITaxon_1206794",
kkonganti@0 95 "Echinodermata":"NCBITaxon_7586",
kkonganti@0 96 "Fungi":"NCBITaxon_4751",
kkonganti@0 97 "Mammalia":"NCBITaxon_40674",
kkonganti@0 98 "Sauropsida":"NCBITaxon_8457",
kkonganti@0 99 "Spiralia":"NCBITaxon_2697495",
kkonganti@0 100 "Viridiplantae":"NCBITaxon_33090"
kkonganti@0 101 }
kkonganti@0 102 }
kkonganti@0 103
kkonganti@0 104 ----
kkonganti@0 105
kkonganti@0 106 .. class:: infomark
kkonganti@0 107
kkonganti@0 108 **Outputs**
kkonganti@0 109
kkonganti@0 110 The main output files are:
kkonganti@0 111
kkonganti@0 112 ::
kkonganti@0 113
kkonganti@0 114 - An tab-seperated file with possible matched annotations.
kkonganti@0 115 - A list of Lexmapr2 figures in PNG format.
kkonganti@0 116
kkonganti@0 117 ]]></help>
kkonganti@0 118 <citations>
kkonganti@0 119 <citation type="bibtex">
kkonganti@0 120 @misc{github,
kkonganti@0 121 author = {Penn, Kayla},
kkonganti@0 122 year = {2022},
kkonganti@0 123 title = {LexMapr2},
kkonganti@0 124 publisher = {GitHub},
kkonganti@0 125 journal = {GitHub repository},
kkonganti@0 126 url = {https://github.com/CFSAN-Biostatistics/LexMapr2}}
kkonganti@0 127 </citation>
kkonganti@0 128 <citation type="bibtex">
kkonganti@0 129 @misc{GalaxyToolWrapper,
kkonganti@0 130 author = {Konganti, Kranti},
kkonganti@2 131 year = {2022},
kkonganti@2 132 title = {Lexmapr2 Tool Wrapper for Galaxy},
kkonganti@2 133 journal = {GalaxyTrakr Tool repository},
kkonganti@2 134 url = {https://toolrepo.galaxytrakr.org/repository/browse_repository?id=e00d4fc8bba8b6c5}}
kkonganti@0 135 </citation>
kkonganti@0 136 </citations>
kkonganti@0 137 </tool>