annotate collection_list_render.R @ 0:87c21e14f221 draft

planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
author mingchen0919
date Mon, 25 Sep 2017 12:15:23 -0400
parents
children f85a6bcf940e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
1 ##======= Handle arguments from command line ========
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
2 # setup R error handline to go to stderr
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
3 options(show.error.messages=FALSE,
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
4 error=function(){
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
5 cat(geterrmessage(), file=stderr())
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
6 quit("no", 1, F)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
7 })
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
8
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
9 # we need that to not crash galaxy with an UTF8 error on German LC settings.
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
10 loc = Sys.setlocale("LC_MESSAGES", "en_US.UTF-8")
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
11
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
12 # suppress warning
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
13 options(warn = -1)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
14
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
15 options(stringsAsFactors=FALSE, useFancyQuotes=FALSE)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
16 args = commandArgs(trailingOnly=TRUE)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
17
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
18 suppressPackageStartupMessages({
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
19 library(getopt)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
20 library(tools)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
21 })
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
22
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
23 # column 1: the long flag name
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
24 # column 2: the short flag alias. A SINGLE character string
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
25 # column 3: argument mask
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
26 # 0: no argument
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
27 # 1: argument required
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
28 # 2: argument is optional
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
29 # column 4: date type to which the flag's argument shall be cast.
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
30 # possible values: logical, integer, double, complex, character.
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
31 ##------- 1. input data ---------------------
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
32 spec_list=list()
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
33 spec_list$READS = c('file_list', 'l', '1', 'character')
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
34 spec_list$ECHO = c('echo', 'e', '1', 'character')
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
35 ##--------2. output report and outputs --------------
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
36 spec_list$LIST_COLLECTION = c('list_collection', 'o', '1', 'character')
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
37 spec_list$REPORT = c('report', 'r', '1', 'character')
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
38 ##--------3. Rmd templates in the tool directory ----------
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
39 spec_list$LIST_COLLECTION_RMD = c('list_collection_rmd', 't', '1', 'character')
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
40
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
41 spec = t(as.data.frame(spec_list))
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
42 opt = getopt(spec)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
43 ##====== End of arguments handling ==========
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
44
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
45 #------ Load libraries ---------
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
46 library(rmarkdown)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
47 library(htmltools)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
48
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
49 #----- 1. create the report directory ------------------------
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
50 # this tool does not require an report directory
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
51
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
52 #----- 2. generate Rmd files with Rmd templates --------------
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
53 # a. templates without placeholder variables:
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
54 # copy templates from tool directory to the working directory.
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
55 # b. templates with placeholder variables:
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
56 # substitute variables with user input values and place them in the working directory.
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
57
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
58 #----- 01 list_collection.Rmd -----------------------
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
59 readLines(opt$list_collection_rmd) %>%
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
60 (function(x) {
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
61 gsub('ECHO', opt$echo, x)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
62 }) %>%
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
63 (function(x) {
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
64 fileConn = file('list_collection.Rmd')
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
65 writeLines(x, con=fileConn)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
66 close(fileConn)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
67 })
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
68
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
69 #------ 3. render all Rmd files --------
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
70 render('list_collection.Rmd', output_file = opt$list_collection_html)
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
71
87c21e14f221 planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit fecb83fd1c7b99c3672a61222f3822637eff2571
mingchen0919
parents:
diff changeset
72 #-------4. manipulate outputs -----------------------------