annotate README.md @ 1:52f009b255a1 draft default tip

Updated tool
author simon-gladman
date Thu, 22 Nov 2018 07:07:27 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
1 # Phloseq Ordination Plot
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
2
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
3 A Galaxy tool to produce NMDS plots using Phyloseq from either a BIOM1 file or 2 input tables.
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
4
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
5 Currently produces the plots embedded in a html file for output with links to a PDF file.
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
6
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
7 Requires:
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
8
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
9 Phyloseq 1.22.3
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
10 r-getopt 1.20.0
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
11 r-doparallel 1.0.11
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
12 ghostscript 9.18
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
13
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
14
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
15 ### Run phyloseq_ordination_plot.R with three input files
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
16 Rscript 'phyloseq_ordination_plot.R' --otu_table='GP_OTU_TABLE.txt' --tax_table='GP_TAX_TABLE.txt' --meta_table='GP_SAMPLE_TABLE.txt' --method='bray' --kingdom=2 --cutoff=5 --category=6 --outdir='outputdir' --htmlfile='test.html'
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
17
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
18 ### Run phyloseq_nmds.R with biom file
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
19 Rscript 'phyloseq_ordinate_plot.R' --biom='GP.biom' --subset='Primer' --method='NMDS' --distance='bray' --kingdom='Phylum' --plottype='2' --outdir='outputdir' --htmlfile='biom_out.html'
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
20
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
21 ## Version history:
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
22
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
23 **XML Wrapper:**
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
24
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
25 Alpha version by Michael Thang of QFAB, Australia.
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
26
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
27 1.22.3.1: Simon Gladman Melbourne Bioinformatics
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
28
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
29 * Incorporated tests
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
30 * Requirements
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
31 * Version statement
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
32 * Citations
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
33
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
34 1.22.3.2: Michael Thang QFAB, Simon Gladman Melbourne Bioinformatics
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
35
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
36 * Uses new version of BIOM1 datatype to get metadata
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
37 * Output label changed as per user requirements
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
38
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
39
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
40 **R Script: phyloseq_nmds.R**
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
41
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
42 0.1.0: Michael Thang QFAB
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
43
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
44 * Original version
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
45
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
46 0.1.1: Michael Thang QFAB
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
47
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
48 * Added extra BIOM import functionality so it doesn't solely rely on phyloseq's internal importer.
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
49
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
50 0.1.2: Michael Thang QFAB
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
51
52f009b255a1 Updated tool
simon-gladman
parents:
diff changeset
52 * BIOM functionality now requires the column header name in text.