annotate rmarkdown_feature_counts_render.R @ 11:238d57ce7d74 draft

update
author mingchen0919
date Fri, 29 Dec 2017 14:07:35 -0500
parents 1cff3a3e2b94
children 7a2369ab4f84
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
1 library(getopt)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
2 library(rmarkdown)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
3 library(htmltools)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
4 library(dplyr)
7
mingchen0919
parents: 0
diff changeset
5 library(Rsubread)
11
mingchen0919
parents: 10
diff changeset
6 library(DT)
0
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
7
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
8 ##============ Sink warnings and errors to a file ==============
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
9 ## use the sink() function to wrap all code within it.
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
10 ##==============================================================
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
11 zz = file('warnings_and_errors.txt')
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
12 sink(zz)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
13 sink(zz, type = 'message')
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
14 ##---------below is the code for rendering .Rmd templates-----
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
15
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
16 ##=============STEP 1: handle command line arguments==========
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
17 ##
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
18 ##============================================================
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
19 # column 1: the long flag name
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
20 # column 2: the short flag alias. A SINGLE character string
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
21 # column 3: argument mask
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
22 # 0: no argument
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
23 # 1: argument required
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
24 # 2: argument is optional
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
25 # column 4: date type to which the flag's argument shall be cast.
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
26 # possible values: logical, integer, double, complex, character.
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
27 #-------------------------------------------------------------
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
28 #++++++++++++++++++++ Best practice ++++++++++++++++++++++++++
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
29 # 1. short flag alias should match the flag in the command section in the XML file.
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
30 # 2. long flag name can be any legal R variable names
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
31 # 3. two names in args_list can have common string but one name should not be a part of another name.
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
32 # for example, one name is "ECHO", if another name is "ECHO_XXX", it will cause problems.
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
33 #+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
34 args_list=list()
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
35 ##------- 1. input data ---------------------
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
36 args_list$e = c('echo', 'e', '1', 'logical')
11
mingchen0919
parents: 10
diff changeset
37 args_list$a = c('input_bam_paths', 'a', '1', 'character')
mingchen0919
parents: 10
diff changeset
38 args_list$N = c('input_bam_names', 'N', '1', 'character')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
39 args_list$b = c('annot_inbuilt', 'b', '1', 'character')
7
mingchen0919
parents: 0
diff changeset
40 args_list$c = c('annot_ext', 'c', '1', 'character')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
41 args_list$f = c('isGTFAnnotationFile', 'f', '1', 'logical')
7
mingchen0919
parents: 0
diff changeset
42 args_list$g = c('gtf_feature_type', 'g', '1', 'character')
mingchen0919
parents: 0
diff changeset
43 args_list$h = c('gtf_attr_type', 'h', '1', 'character')
9
mingchen0919
parents: 7
diff changeset
44 args_list$i = c('chr_aliases', 'i', '2', 'character')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
45 args_list$j = c('use_meta_features', 'j', '1', 'logical')
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
46 args_list$k = c('allow_multi_overlap', 'k', '1', 'logical')
9
mingchen0919
parents: 7
diff changeset
47 args_list$l = c('min_overlap', 'l', '1', 'integer')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
48 args_list$m = c('largest_overlap', 'm', '1', 'logical')
9
mingchen0919
parents: 7
diff changeset
49 args_list$n = c('read_extension_5', 'n', '1', 'integer')
mingchen0919
parents: 7
diff changeset
50 args_list$o = c('read_extension_3', 'o', '1', 'integer')
7
mingchen0919
parents: 0
diff changeset
51 args_list$p = c('read_2_pos', 'p', '1', 'character')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
52 args_list$q = c('count_multi_mapping_reads', 'q', '1', 'logical')
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
53 args_list$u = c('fraction', 'u', '1', 'logical')
9
mingchen0919
parents: 7
diff changeset
54 args_list$v= c('min_mqs', 'v', '1', 'integer')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
55 args_list$w= c('split_only', 'w', '1', 'logical')
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
56 args_list$x= c('non_split_only', 'x', '1', 'logical')
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
57 args_list$y= c('primary_only', 'y', '1', 'logical')
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
58 args_list$z= c('ignore_dup', 'z', '1', 'logical')
9
mingchen0919
parents: 7
diff changeset
59 args_list$A= c('strand_specific', 'A', '1', 'integer')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
60 args_list$B= c('junc_counts', 'B', '1', 'logical')
7
mingchen0919
parents: 0
diff changeset
61 args_list$C= c('genome', 'C', '1', 'character')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
62 args_list$D= c('is_paired_end', 'D', '1', 'logical')
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
63 args_list$E= c('require_both_ends_mapped', 'E', '1', 'logical')
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
64 args_list$F= c('check_frag_length', 'F', '1', 'logical')
9
mingchen0919
parents: 7
diff changeset
65 args_list$G= c('min_frag_length', 'G', '1', 'integer')
mingchen0919
parents: 7
diff changeset
66 args_list$H= c('max_frag_length', 'H', '1', 'integer')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
67 args_list$I= c('count_chimeric_fragments', 'I', '1', 'logical')
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
68 args_list$J= c('auto_sort', 'J', '1', 'logical')
9
mingchen0919
parents: 7
diff changeset
69 args_list$K= c('n_threads', 'K', '1', 'integer')
mingchen0919
parents: 7
diff changeset
70 args_list$L= c('max_mop', 'L', '1', 'integer')
10
1cff3a3e2b94 working version
mingchen0919
parents: 9
diff changeset
71 args_list$M= c('report_reads', 'M', '1', 'logical')
7
mingchen0919
parents: 0
diff changeset
72
0
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
73 ##--------2. output report and outputs --------------
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
74 args_list$REPORT_HTML = c('report_html', 'r', '1', 'character')
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
75 args_list$REPORT_DIR = c('report_dir', 'd', '1', 'character')
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
76 args_list$SINK_MESSAGE = c('sink_message', 's', '1', 'character')
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
77 ##--------3. .Rmd templates in the tool directory ----------
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
78 args_list$TOOL_TEMPLATE_RMD = c('tool_template_rmd', 't', '1', 'character')
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
79 ##-----------------------------------------------------------
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
80 opt = getopt(t(as.data.frame(args_list)))
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
81
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
82
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
83
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
84 ##=======STEP 2: create report directory (optional)==========
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
85 ##
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
86 ##===========================================================
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
87 dir.create(opt$report_dir)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
88
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
89 ##=STEP 3: replace placeholders in .Rmd with argument values=
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
90 ##
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
91 ##===========================================================
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
92 #++ need to replace placeholders with args values one by one+
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
93 readLines(opt$tool_template_rmd) %>%
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
94 (function(x) {
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
95 gsub('ECHO', opt$echo, x)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
96 }) %>%
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
97 (function(x) {
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
98 gsub('REPORT_DIR', opt$report_dir, x)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
99 }) %>%
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
100 (function(x) {
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
101 fileConn = file('tool_template.Rmd')
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
102 writeLines(x, con=fileConn)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
103 close(fileConn)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
104 })
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
105
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
106
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
107 ##=============STEP 4: render .Rmd templates=================
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
108 ##
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
109 ##===========================================================
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
110 render('tool_template.Rmd', output_file = opt$report_html)
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
111
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
112
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
113 ##--------end of code rendering .Rmd templates----------------
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
114 sink()
8bcae2a95fe7 planemo upload
mingchen0919
parents:
diff changeset
115 ##=========== End of sinking output=============================