Mercurial > repos > greg > vsnp_excel_filter

changeset 0:3fbd172e4055 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author greg
date Mon, 09 Mar 2020 13:42:19 -0400
parents
children
files .shed.yml data_manager/vsnp_excel_filter_fetcher.py data_manager/vsnp_excel_filter_fetcher.xml data_manager_conf.xml tool-data/vsnp_excel_filter.loc.sample tool_data_table_conf.xml.sample
diffstat 6 files changed, 209 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.shed.yml	Mon Mar 09 13:42:19 2020 -0400
@@ -0,0 +1,10 @@
+name: data_manager_vsnp_excel_filter
+owner: greg
+description: Data manager to download vSNP analysis Excel filter file
+homepage_url: https://github.com/USDA-VS/vSNP
+long_description: |
+  vSNP generates annotated SNP tables, this data manager installs the vSNP Excel filter file.
+remote_repository_url: "https://github.com/gregvonkuster/galaxy_tools/tree/master/tools/data_managers/vsnp_excel_filter"
+type: unrestricted
+categories:
+- Data Managers
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/data_manager/vsnp_excel_filter_fetcher.py	Mon Mar 09 13:42:19 2020 -0400
@@ -0,0 +1,66 @@
+import argparse
+import json
+import os
+import sys
+try:
+    # For Python 3.0 and later
+    from urllib.request import Request, urlopen
+except ImportError:
+    # Fall back to Python 2 imports
+    from urllib2 import Request, urlopen
+
+
+def url_download(url, workdir):
+    file_path = os.path.abspath(os.path.join(workdir, os.path.basename(url)))
+    src = None
+    dst = None
+    try:
+        req = Request(url)
+        src = urlopen(req)
+        with open(file_path, 'wb') as dst:
+            while True:
+                chunk = src.read(2**10)
+                if chunk:
+                    dst.write(chunk)
+                else:
+                    break
+    except Exception as e:
+        sys.exit(str(e))
+    finally:
+        if src:
+            src.close()
+    return file_path
+
+
+def download(dbkey, name, url, out_file):
+
+    with open(out_file) as fh:
+        params = json.loads(fh.read())
+
+    workdir = params['output_data'][0]['extra_files_path']
+    os.makedirs(workdir)
+    file_path = url_download(url, workdir)
+    entry_name = os.path.basename(file_path)
+
+    data_manager_json = {"data_tables": {}}
+    data_manager_entry = {}
+    data_manager_entry['value'] = dbkey
+    data_manager_entry['name'] = entry_name
+    data_manager_entry['path'] = file_path
+    data_manager_entry['description'] = "Excel Filter file for %s" % name
+    data_manager_json["data_tables"]["vsnp_excel_filter"] = data_manager_entry
+
+    with open(out_file, 'w') as fh:
+        fh.write(json.dumps(data_manager_json, sort_keys=True))
+
+
+parser = argparse.ArgumentParser()
+
+parser.add_argument('--dbkey', dest='dbkey', help='Genome reference dbkey')
+parser.add_argument('--name', dest='name', help='Reference display name')
+parser.add_argument('--url', dest='url', help='URL to download Excel file')
+parser.add_argument('--out_file', dest='out_file', help='JSON output file')
+
+args = parser.parse_args()
+
+download(args.dbkey, args.name, args.url, args.out_file)
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/data_manager/vsnp_excel_filter_fetcher.xml	Mon Mar 09 13:42:19 2020 -0400
@@ -0,0 +1,101 @@
+<?xml version="1.0"?>
+<tool id="vsnp_excel_filter_fetcher" name="vSNP Excel Filter data manager" tool_type="manage_data" profile="18.09" version="0.0.8">
+    <description>Download vSNP Excel files</description>
+    <requirements>
+        <requirement type="package" version="3.7">python</requirement>
+    </requirements>
+    <command detect_errors="exit_code"><![CDATA[
+    python '$__tool_directory__/vsnp_excel_filter_fetcher.py'
+    --dbkey '${all_fasta_source.fields.dbkey}'
+    --name '${all_fasta_source.fields.name}'
+    --out_file '$out_file'
+    --url '$url'
+    ]]>
+    </command>
+    <inputs>
+        <param name="all_fasta_source" type="select" label="FASTA reference">
+            <options from_data_table="all_fasta"/>
+        </param>
+        <param name="url" type="text" value="" label="URL to download the Excel Filter file associated with the selected FASTA reference" optional="False" />
+    </inputs>
+    <outputs>
+        <data name="out_file" format="data_manager_json" />
+    </outputs>
+    <tests>
+        <test>
+        </test>
+    </tests>
+    <help><![CDATA[
+This tool fetches a vSNP Excel Filter file associated with each supported genome reference to populate the vsnp_excel_filter data table.
+The dbkey and name fields in the vsnp data table are inherited from the *all_fasta* data table, so no user entry is necessary.  These
+public vSNP Excel Filter files are available in GitHub at https://github.com/USDA-VS/vSNP_reference_options.  Note that the file names
+are a bit confusing.  This tool must be used for Excel files with the pattern "remove_from_analysis" in the name.
+
+ * **Mycobacterium bovis AF2122/97**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Mycobacterium_AF2122/Mbovis_remove_from_analysis.xlsx
+
+ * **Brucella abortus bv. 1 str. 9-941**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_abortus1/Bab1_remove_from_analysis.xlsx
+
+ * **Brucella abortus strain BER**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_abortus3/Bab3_remove_from_analysis.xlsx
+
+ * **Brucella canis ATCC 23365**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_canis/Bcanis_remove_from_analysis.xlsx
+
+ * **Brucella ceti TE10759-12**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_ceti2/Bceti2_remove_from_analysis.xlsx
+
+ * **Brucella melitensis bv. 1 str. 16M**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_melitensis-bv1/Bmelbv1_remove_from_analysis.xlsx
+
+ * **Brucella melitensis bv. 3 str. Ether**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_melitensis-bv3/Bmelbv3_remove_from_analysis.xlsx
+
+ * **Brucella melitensis BwIM_SOM_36b**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_melitensis-bv1b/Bmelbv1b_remove_from_analysis.xlsx
+
+ * **Brucella melitensis ATCC 23457**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_melitensis-bv2/Bmelbv2_remove_from_analysis.xlsx
+
+ * **Brucella ovis ATCC 25840**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_ovis/B_ovis_remove_from_analysis.xlsx
+
+ * **Brucella suis 1330**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_suis1/Bsuis1_remove_from_analysis.xlsx
+
+ * **Mycobacterium tuberculosis H37Rv**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Mycobacterium_H37/H37_remove_from_analysis.xlsx
+
+ * **Mycobacterium avium subsp. paratuberculosis strain Telford**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/para-CP033688/CP033688_remove_from_analysis.xlsx
+
+ * **Mycobacterium avium subsp. paratuberculosis K-10**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/para-NC002944/NC_002944_remove_from_analysis.xlsx
+
+ * **Brucella suis ATCC 23445**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_suis2/Bsuis2_remove_from_analysis.xlsx
+
+ * **Brucella suis bv. 3 str. 686**
+
+   * **Excel file**    https://github.com/USDA-VS/vSNP_reference_options/raw/master/Brucella_suis3/Bsuis3_remove_from_analysis.xlsx
+
+    ]]></help>
+    <citations>
+    </citations>
+</tool>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/data_manager_conf.xml	Mon Mar 09 13:42:19 2020 -0400
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<data_managers>
+    <data_manager tool_file="data_manager/vsnp_excel_filter_fetcher.xml" id="vsnp_excel_filter_fetcher">
+        <data_table name="vsnp_excel_filter">
+            <output>
+                <column name="value" />
+                <column name="name" />
+                <column name="path" output_ref="out_file">
+                    <move type="file" relativize_symlinks="True">
+                        <source>${path}</source>
+			<target base="${GALAXY_DATA_MANAGER_DATA_PATH}">vsnp/${value}/excel_filter/${name}</target>
+                    </move>
+		    <value_translation>${GALAXY_DATA_MANAGER_DATA_PATH}/vsnp/${value}/excel_filter/${name}</value_translation>
+                    <value_translation type="function">abspath</value_translation>
+                </column>
+                <column name="description" />
+            </output>
+        </data_table>
+    </data_manager>
+</data_managers>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tool-data/vsnp_excel_filter.loc.sample	Mon Mar 09 13:42:19 2020 -0400
@@ -0,0 +1,4 @@
+## vSNP Excel Filter files
+#Value	Name	Path	Description
+#AF2122	Mbovis_define_filter.xlsx	vsnp/AF2122/Mbovis_remove_from_analysis.xlsx    Excel filter file for Mycobacterium bovis AF2122/97
+#NC_006932	Bab1_define_filter.xlsx	/vsnp/NC_006932/Bab1_remove_from_analysis.xlsx	Excel filter file for Brucella abortus bv. 1 str. 9-941
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tool_data_table_conf.xml.sample	Mon Mar 09 13:42:19 2020 -0400
@@ -0,0 +1,7 @@
+<tables>
+    <table name="vsnp_excel_filter" comment_char="#">
+        <columns>value, name, path, description</columns>
+        <file path="tool-data/vsnp_excel_filter.loc" />
+    </table>
+</tables>
+