annotate rmarkdown_samtools_flagstat_render.R @ 4:ec39bfeaf496 draft

update
author mingchen0919
date Wed, 27 Dec 2017 15:14:47 -0500
parents a0f0effea707
children 1c16536c70f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
1 library(getopt)
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
2 library(rmarkdown)
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
3 library(htmltools)
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
4 library(dplyr)
4
mingchen0919
parents: 1
diff changeset
5 library(stringr)
1
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
6
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
7 ##============ Sink warnings and errors to a file ==============
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
8 ## use the sink() function to wrap all code within it.
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
9 ##==============================================================
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
10 zz = file('warnings_and_errors.txt')
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
11 sink(zz)
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
12 sink(zz, type = 'message')
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
13 ##---------below is the code for rendering .Rmd templates-----
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
14
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
15 ##=============STEP 1: handle command line arguments==========
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
16 ##
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
17 ##============================================================
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
18 # column 1: the long flag name
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
19 # column 2: the short flag alias. A SINGLE character string
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
20 # column 3: argument mask
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
21 # 0: no argument
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
22 # 1: argument required
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
23 # 2: argument is optional
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
24 # column 4: date type to which the flag's argument shall be cast.
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
25 # possible values: logical, integer, double, complex, character.
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
26 #-------------------------------------------------------------
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
27 #++++++++++++++++++++ Best practice ++++++++++++++++++++++++++
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
28 # 1. short flag alias should match the flag in the command section in the XML file.
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
29 # 2. long flag name can be any legal R variable names
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
30 # 3. two names in args_list can have common string but one name should not be a part of another name.
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
31 # for example, one name is "ECHO", if another name is "ECHO_XXX", it will cause problems.
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
32 #+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
33 args_list=list()
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
34 ##------- 1. input data ---------------------
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
35 args_list$ECHO = c('echo', 'e', '1', 'character')
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
36 args_list$INPUT_BAM = c('input_bam', 'b', '1', 'character')
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
37 ##--------2. output report and outputs --------------
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
38 args_list$REPORT_HTML = c('report_html', 'r', '1', 'character')
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
39 args_list$REPORT_DIR = c('report_dir', 'd', '1', 'character')
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
40 args_list$SINK_MESSAGE = c('sink_message', 's', '1', 'character')
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
41 ##--------3. .Rmd templates in the tool directory ----------
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
42 args_list$TOOL_TEMPLATE_RMD = c('tool_template_rmd', 't', '1', 'character')
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
43 ##-----------------------------------------------------------
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
44 opt = getopt(t(as.data.frame(args_list)))
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
45
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
46
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
47
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
48 ##=======STEP 2: create report directory (optional)==========
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
49 ##
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
50 ##===========================================================
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
51 dir.create(opt$report_dir)
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
52
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
53 ##=STEP 3: replace placeholders in .Rmd with argument values=
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
54 ##
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
55 ##===========================================================
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
56 #++ need to replace placeholders with args values one by one+
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
57 readLines(opt$tool_template_rmd) %>%
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
58 (function(x) {
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
59 gsub('ECHO', opt$echo, x)
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
60 }) %>%
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
61 (function(x) {
4
mingchen0919
parents: 1
diff changeset
62 gsub('REPORT_DIR', opt$report_dir, x)
1
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
63 }) %>%
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
64 (function(x) {
4
mingchen0919
parents: 1
diff changeset
65 fileConn = file('rmarkdown_samtools_flagstat.Rmd')
1
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
66 writeLines(x, con=fileConn)
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
67 close(fileConn)
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
68 })
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
69
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
70
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
71 ##=============STEP 4: render .Rmd templates=================
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
72 ##
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
73 ##===========================================================
4
mingchen0919
parents: 1
diff changeset
74 render('rmarkdown_samtools_flagstat.Rmd', output_file = opt$report_html)
1
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
75
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
76
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
77 ##--------end of code rendering .Rmd templates----------------
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
78 sink()
a0f0effea707 fix wrong input type error
mingchen0919
parents:
diff changeset
79 ##=========== End of sinking output=============================