# HG changeset patch # User jjohnson # Date 1307480052 14400 # Node ID 591e72edabed39cd026410203c5b4498cc0a7f14 Migrated tool version 1.15.1 from old tool shed archive to new tool shed repository diff -r 000000000000 -r 591e72edabed mothur/README --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mothur/README Tue Jun 07 16:54:12 2011 -0400 @@ -0,0 +1,248 @@ +Provides galaxy tools for the Mothur metagenomics package - http://www.mothur.org/wiki/Main_Page + +Install mothur v.1.15.0 on your galaxy system so galaxy can execute the mothur command + http://www.mothur.org/wiki/Download_mothur + http://www.mothur.org/wiki/Installation + ( This Galaxy iMothur wrapper will invoke Mothur in command line mode: http://www.mothur.org/wiki/Command_line_mode ) + +TreeVector is also packaged with this Mothur package to view phylogenetic trees: + TreeVector is a utility to create and integrate phylogenetic trees as Scalable Vector Graphics (SVG) files. + TreeVector was written by Ralph_Pethica, Department_of_Computer_Science, University_of_Bristol + TreeVector: http://supfam.cs.bris.ac.uk/TreeVector/about.html + Install in galaxy: tool-data/shared/jars/TreeVector.jar + +Install reference data from silva and greengenes + Silva reference: + http://www.mothur.org/wiki/Silva_reference_files + - Bacterial references (14,956 sequences) + http://www.mothur.org/w/images/9/98/Silva.bacteria.zip + - Archaeal references (2,297 sequences) + http://www.mothur.org/w/images/3/3c/Silva.archaea.zip + - Eukaryotic references (1,238 sequences) + http://www.mothur.org/w/images/1/1a/Silva.eukarya.zip + - Silva-based alignment of template file for chimera.slayer (5,181 sequences) + http://www.mothur.org/w/images/f/f1/Silva.gold.bacteria.zip + Alignment database rRNA gene sequences: + http://www.mothur.org/wiki/Alignment_database + - greengenes reference alignment + http://www.mothur.org/w/images/7/72/Greengenes.alignment.zip + - SILVA (Silva reference) + http://www.mothur.org/w/images/f/f1/Silva.gold.bacteria.zip + Secondary structure mapping files: + http://www.mothur.org/wiki/Secondary_structure_map + http://www.mothur.org/w/images/6/6d/Silva_ss_map.zip + http://www.mothur.org/w/images/4/4b/Gg_ss_map.zip + Lane masks: + http://www.mothur.org/wiki/Lane_mask + greengenes-compatible mask: + - lane1241.gg.filter - A Lane Masks that comes with the greengenes arb database + http://www.mothur.org/w/images/2/2a/Lane1241.gg.filter + - lane1287.gg.filter - A Lane Masks that comes with the greengenes arb database + http://www.mothur.org/w/images/a/a0/Lane1287.gg.filter + - lane1349.gg.filter - Pat Schloss's transcription of the mask from the Lane paper + http://www.mothur.org/w/images/3/3d/Lane1349.gg.filter + SILVA-compatible mask: + - lane1349.silva.filter - Pat Schloss's transcription of the mask from the Lane paper + http://www.mothur.org/w/images/6/6d/Lane1349.silva.filter + + Example from UMN installation: (We also made these available in a Galaxy public data library) + /project/db/galaxy/mothur/Silva.bacteria.zip + /project/db/galaxy/mothur/silva.eukarya.fasta + /project/db/galaxy/mothur/Greengenes.alignment.zip + /project/db/galaxy/mothur/Silva.archaea.zip + /project/db/galaxy/mothur/Silva_ss_map.zip + /project/db/galaxy/mothur/silva.eukarya.ncbi.tax + /project/db/galaxy/mothur/Silva.gold.bacteria.zip + /project/db/galaxy/mothur/Silva.archaea/silva.archaea.silva.tax + /project/db/galaxy/mothur/Silva.archaea/silva.archaea.gg.tax + /project/db/galaxy/mothur/Silva.archaea/silva.archaea.rdp.tax + /project/db/galaxy/mothur/Silva.archaea/nogap.archaea.fasta + /project/db/galaxy/mothur/Silva.archaea/silva.archaea.ncbi.tax + /project/db/galaxy/mothur/Silva.archaea/silva.archaea.fasta + /project/db/galaxy/mothur/nogap.eukarya.fasta + /project/db/galaxy/mothur/silva.eukarya.silva.tax + /project/db/galaxy/mothur/silva.gold.align + /project/db/galaxy/mothur/silva.ss.map + /project/db/galaxy/mothur/gg.ss.map + /project/db/galaxy/mothur/silva.bacteria/silva.bacteria.silva.tax + /project/db/galaxy/mothur/silva.bacteria/silva.bacteria.rdp6.tax + /project/db/galaxy/mothur/silva.bacteria/nogap.bacteria.fasta + /project/db/galaxy/mothur/silva.bacteria/silva.bacteria.gg.tax + /project/db/galaxy/mothur/silva.bacteria/silva.bacteria.ncbi.tax + /project/db/galaxy/mothur/silva.bacteria/silva.bacteria.fasta + /project/db/galaxy/mothur/silva.bacteria/silva.bacteria.rdp.tax + /project/db/galaxy/mothur/Silva.eukarya.zip + /project/db/galaxy/mothur/Gg_ss_map.zip + /project/db/galaxy/mothur/core_set_aligned.imputed.fasta + + +Add tool-data: (contains pointers to silva and greengenes reference data) + tool-data/mothur_aligndb.loc + tool-data/mothur_calulators.loc + tool-data/mothur_map.loc + tool-data/mothur_taxonomy.loc + tool-data/shared/jars/TreeVector.jar + + +add config files (*.xml) and wrapper code (*.py) from tools/mothur/* to your galaxy installation + + +add datatype definition file: lib/galaxy/datatypes/metagenomics.py + +add the following import line to: lib/galaxy/datatypes/registry.py +import metagenomics # added for metagenomics mothur + + +add datatypes to: datatypes_conf.xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +add mothur tools to: tool_conf.xml +
+
+ + +############ DESIGN NOTES ######################################################################################################### +Each mothur command has it's own tool_config (.xml) file, but all call the same python wrapper code: mothur_wrapper.py + +* Every mothur tool will call mothur_wrapper.py script with a --cmd= parameter that gives the mothur command name. +* Many mothur commands require date to be read into memory (using read.dist, read.otu, read.tree) before executed the command, + these are accomplished in the tool_config and mothur_wrapper.py with --READ_cmd= and --READ_