annotate README.md @ 3:5a2bda9b28c5 draft

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