annotate dynamic_tool.Rmd @ 0:d79569f269c7 draft

planemo upload
author mingchen0919
date Fri, 23 Mar 2018 01:53:24 -0400
parents
children a9579c344a90
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
1 ---
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
2 title: 'Dynamic tool'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
3 output: html_document
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
4 ---
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
5
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
6 ```{r setup, include=FALSE, warning=FALSE, message=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
7 knitr::opts_chunk$set(error = TRUE)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
8 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
9
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
10 ## User input
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
11
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
12 ```{r, echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
13 ##-------- build script files -----------
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
14
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
15 # build script file: script.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
16 df = read.table(paste0(Sys.getenv('REPORT_FILES_PATH'), '/options_and_arguments.txt'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
17 sep = '|', header = TRUE)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
18
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
19 # get tool name
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
20 tool_name = df[df$type == 'tool_name', 'value']
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
21 # build script for displaying help messages (this probably should be tool specific)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
22 write(paste0(tool_name, ' -h'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
23 file = paste0(Sys.getenv('REPORT_FILES_PATH'), '/help.sh'))
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
24
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
25 knitr::kable(df[, c('flag', 'value')])
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
26
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
27 # if the number of option/argument pairs is larger than 0, build script file
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
28 df2 = df[df$type != 'tool_name', ]
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
29 if (nrow(df2) > 0) {
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
30 # write tool name as the first line of the script.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
31 # before running the job, cd into the ${REPORT_FILES_PATH} directory
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
32 write(paste0(tool_name, ' \\'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
33 paste0(Sys.getenv('REPORT_FILES_PATH'), '/script.sh'))
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
34 df2 = df[df$type != 'tool_name', ]
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
35 write(paste(' ', df2$flag, df2$value, '\\', sep = ' '),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
36 file = paste0(Sys.getenv('REPORT_FILES_PATH'), '/script.sh'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
37 append = TRUE )
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
38 # remember that after writing option/argument lines to the script.sh, the last line
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
39 # has an extra newline character '\' which causes a problem. We can either remove that extra
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
40 # '\' or add a new line to the end. We choose to add a new line.
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
41
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
42 # add an extra line to the end to redirect stdout to stdout.txt and stderr to stderr.txt
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
43 write(' > ${REPORT_FILES_PATH}/stdout.txt 2>${REPORT_FILES_PATH}/stderr.txt',
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
44 paste0(Sys.getenv('REPORT_FILES_PATH'), '/script.sh'), append = TRUE)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
45 } else {
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
46 # if no option/argument input, simply display the help message
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
47 write(paste0(tool_name, ' -h'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
48 file = paste0(Sys.getenv('REPORT_FILES_PATH'), '/script.sh'))
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
49 }
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
50
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
51 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
52
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
53
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
54 ```{bash, echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
55 ## code to open help documentation
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
56 sh ${REPORT_FILES_PATH}/help.sh > ${TOOL_HELP_DOC}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
57 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
58
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
59 ```{bash, results='asis', echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
60 echo '## Show help documentation'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
61 echo ''
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
62 echo ''
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
63 echo '```bash'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
64 cat ${REPORT_FILES_PATH}/help.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
65 echo '```'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
66 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
67
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
68
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
69 ```{bash, echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
70 # run job script
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
71 # it's important to run the job within the REPORT_FILES_PATH
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
72 cd ${REPORT_FILES_PATH} && sh script.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
73 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
74
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
75 ```{bash, results='asis', echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
76 echo '## Job script'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
77 echo ''
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
78 echo ''
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
79 echo '```bash'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
80 cat ${REPORT_FILES_PATH}/script.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
81 echo '```'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
82 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
83
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
84
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
85 ```{r, results='asis', echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
86 cat('##All output files')
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
87 cat('\n\n')
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
88 all_files = list.files(path = Sys.getenv('REPORT_FILES_PATH'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
89 full.names = TRUE,
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
90 recursive = TRUE)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
91
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
92 for (f in sub(Sys.getenv('REPORT_FILES_PATH'), '.', all_files) ) {
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
93 cat('* [', f, '](', f, ')\n')
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
94 }
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
95 cat('\n')
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
96 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
97