annotate maaslin-4450aa4ecc84/maaslin-4450aa4ecc84/src/CreateReadConfigFile.R @ 6:ca61989bc3b4

Uploaded
author george-weingart
date Sun, 08 Feb 2015 23:39:43 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
1 #!/usr/bin/env Rscript
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
2 #####################################################################################
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
3 #Copyright (C) <2012>
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
4 #
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
5 #Permission is hereby granted, free of charge, to any person obtaining a copy of
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
6 #this software and associated documentation files (the "Software"), to deal in the
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
7 #Software without restriction, including without limitation the rights to use, copy,
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
8 #modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
9 #and to permit persons to whom the Software is furnished to do so, subject to
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
10 #the following conditions:
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
11 #
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
12 #The above copyright notice and this permission notice shall be included in all copies
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
13 #or substantial portions of the Software.
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
14 #
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
15 #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
16 #INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
17 #PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
18 #HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
19 #OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
20 #SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
21 #
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
22 # This file is a component of the MaAsLin (Multivariate Associations Using Linear Models),
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
23 # authored by the Huttenhower lab at the Harvard School of Public Health
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
24 # (contact Timothy Tickle, ttickle@hsph.harvard.edu).
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
25 #####################################################################################
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
26
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
27 inlinedocs <- function(
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
28 ##author<< Curtis Huttenhower <chuttenh@hsph.harvard.edu> and Timothy Tickle <ttickle@hsph.harvard.edu>
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
29 ##description<< Allows read config files to be created.
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
30 ) { return( pArgs ) }
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
31
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
32 ### Logging class
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
33 suppressMessages(library( logging, warn.conflicts=FALSE, quietly=TRUE, verbose=FALSE))
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
34 ### Class for commandline argument processing
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
35 suppressMessages(library( optparse, warn.conflicts=FALSE, quietly=TRUE, verbose=FALSE))
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
36
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
37 ### Source the IO.R for the script
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
38 source(file.path("src","lib","IO.R"))
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
39 source(file.path("src","lib","Constants.R"))
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
40
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
41 ### Create command line argument parser
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
42 ### The TSV (tab seperated value (column major, samples are rows) file that will be read in
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
43 ### The column that is the last metadata name
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
44 ### The read.config file that will be used to read in the TSV file
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
45 pArgs <- OptionParser( usage = "%prog [optional] <strOutputRC> <strMatrixName>" )
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
46 # Settings for Read config
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
47 ## row indices
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
48 pArgs <- add_option( pArgs, c("-r", "--rows"), type="character", action="store", dest="strRows", default=NA, metavar="row_indices", help="Rows to read by index starting with 1.")
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
49 ## column indices
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
50 pArgs <- add_option( pArgs, c("-c", "--columns"), type="character", action="store", dest="strColumns", default=NA, metavar="column_indices", help="Columns to read in by index starting with 1.")
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
51 ## delimiter
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
52 pArgs <- add_option( pArgs, c("-d", "--delimiter"), type="character", action="store", dest="charDelimiter", default="\t", metavar="delimiter", help="Delimiter to read the matrix.")
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
53 ## append to current file
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
54 pArgs <- add_option( pArgs, c("-a", "--append"), type="logical", action="store_true", dest="fAppend", default=FALSE, metavar="append", help="Append to existing data. Default no append.")
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
55 ### Parse arguments
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
56 lsArgs <- parse_args( pArgs, positional_arguments = TRUE )
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
57
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
58 #Get positional arguments
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
59 if( !(length( lsArgs$args ) == 2) ) { stop( print_help( pArgs ) ) }
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
60
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
61 ### Write to file the read config script
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
62 funcWriteMatrixToReadConfigFile(strConfigureFileName=lsArgs$args[1], strMatrixName=lsArgs$args[2], strRowIndices=lsArgs$options$strRows,
ca61989bc3b4 Uploaded
george-weingart
parents:
diff changeset
63 strColIndices=lsArgs$options$strColumns,acharDelimiter=lsArgs$options$charDelimiter,fAppend=lsArgs$options$fAppend)