Mercurial > repos > mingchen0919 > dynamic_star

annotate dynamic_tool.Rmd @ 2:a9579c344a90 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
author mingchen0919
date Fri, 23 Mar 2018 21:50:16 -0400
parents d79569f269c7
children
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
2
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
6 <style>
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
7 pre code, pre, code {
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
8 white-space: pre !important;
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
9 overflow-x: scroll !important;
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
10 word-break: keep-all !important;
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
11 word-wrap: initial !important;
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
12 }
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
13 </style>
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
14
0
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
15 ```{r setup, include=FALSE, warning=FALSE, message=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
16 knitr::opts_chunk$set(error = TRUE)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
17 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
18
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
19 ## User input
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
20
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
21 ```{r, echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
22 ##-------- build script files -----------
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
23
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
24 # build script file: script.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
25 df = read.table(paste0(Sys.getenv('REPORT_FILES_PATH'), '/options_and_arguments.txt'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
26 sep = '|', header = TRUE)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
27
2
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
28 # prepend A_TOOL_OUTPUT_PATH
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
29 if (nrow(df[df$type == 'path_relative_to_a_tool', ]) > 0) {
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
30 for (i in 1:nrow(df[df$type == 'path_relative_to_a_tool', ])) {
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
31 root_path = readLines(df[df$type == 'path_relative_to_a_tool', ][i, 'path_type'])[1]
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
32 df[df$type == 'path_relative_to_a_tool', ][i, 'value'] = paste(root_path,
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
33 df[df$type == 'path_relative_to_a_tool', ][i, 'value'],
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
34 sep = '/')
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
35 }
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
36 }
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
37
0
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
38 # get tool name
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
39 tool_name = df[df$type == 'tool_name', 'value']
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
40 # build script for displaying help messages (this probably should be tool specific)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
41 write(paste0(tool_name, ' -h'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
42 file = paste0(Sys.getenv('REPORT_FILES_PATH'), '/help.sh'))
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
43
2
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
44 knitr::kable(df)
0
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
45
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
46 # if the number of option/argument pairs is larger than 0, build script file
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
47 df2 = df[df$type != 'tool_name', ]
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
48 if (nrow(df2) > 0) {
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
49 # write tool name as the first line of the script.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
50 # before running the job, cd into the ${REPORT_FILES_PATH} directory
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
51 write(paste0(tool_name, ' \\'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
52 paste0(Sys.getenv('REPORT_FILES_PATH'), '/script.sh'))
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
53 df2 = df[df$type != 'tool_name', ]
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
54 write(paste(' ', df2$flag, df2$value, '\\', sep = ' '),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
55 file = paste0(Sys.getenv('REPORT_FILES_PATH'), '/script.sh'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
56 append = TRUE )
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
57 # remember that after writing option/argument lines to the script.sh, the last line
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
58 # has an extra newline character '\' which causes a problem. We can either remove that extra
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
59 # '\' or add a new line to the end. We choose to add a new line.
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
60
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
61 # 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
62 write(' > ${REPORT_FILES_PATH}/stdout.txt 2>${REPORT_FILES_PATH}/stderr.txt',
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
63 paste0(Sys.getenv('REPORT_FILES_PATH'), '/script.sh'), append = TRUE)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
64 } else {
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
65 # if no option/argument input, simply display the help message
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
66 write(paste0(tool_name, ' -h'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
67 file = paste0(Sys.getenv('REPORT_FILES_PATH'), '/script.sh'))
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
68 }
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
69
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
70 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
71
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
72
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
73 ```{bash, echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
74 ## code to open help documentation
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
75 sh ${REPORT_FILES_PATH}/help.sh > ${TOOL_HELP_DOC}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
76 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
77
2
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
78
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
79 ```{r, echo=FALSE}
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
80 # create paths before running the job script
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
81 df_paths = df[df$type == 'path_relative_to_this_tool', ]
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
82
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
83 if (nrow(df_paths) > 0) {
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
84 for (i in 1:nrow(df_paths)) {
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
85 path = paste0(Sys.getenv('REPORT_FILES_PATH'), '/', df_paths[i, 'value'])
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
86 path_type = df_paths[i, 'path_type']
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
87
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
88 # create file paths
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
89 if ((path_type == 'file_path') & !file.exists(path)) {
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
90 dir_path = paste(head(strsplit(path, '/')[[1]], -1), collapse = '/' )
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
91 if (!dir.exists(dir_path)) {
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
92 dir.create(dir_path, recursive = TRUE)
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
93 }
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
94 file.create(path)
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
95 }
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
96
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
97 # create dir paths
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
98 if ((path_type == 'dir_path') & !dir.exists(path)) {
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
99 dir.create(path, recursive = TRUE)
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
100 }
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
101 }
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
102 }
0
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
103 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
104
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
105
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
106 ```{bash, echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
107 # run job script
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
108 # it's important to run the job within the REPORT_FILES_PATH
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
109 cd ${REPORT_FILES_PATH} && sh script.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
110 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
111
2
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
112
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
113
0
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
114 ```{bash, results='asis', echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
115 echo '## Job script'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
116 echo ''
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
117 echo ''
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
118 echo '```bash'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
119 cat ${REPORT_FILES_PATH}/script.sh
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
120 echo '```'
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
121 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
122
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
123
2
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
124 ```{r, echo=FALSE}
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
125 ## obtain REPORT_FILES_PAHT and save it to a galaxy output.
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
126 database_root = paste(head(strsplit(Sys.getenv('TOOL_LOG'), '/')[[1]], -1), collapse = '/')
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
127 tool_output_dir_id = tail(strsplit(Sys.getenv('REPORT_FILES_PATH'), '/')[[1]], 1)
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
128 tool_output_dir = paste0(database_root, '/', tool_output_dir_id)
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
129 write(tool_output_dir, Sys.getenv('TOOL_OUTPUT_DIR'))
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
130 ```
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
131
a9579c344a90 planemo upload commit 8f84e3911c6ff4103c0ad5fb8dd774f80d9b2559
mingchen0919
parents: 0
diff changeset
132
0
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
133 ```{r, results='asis', echo=FALSE}
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
134 cat('##All output files')
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
135 cat('\n\n')
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
136 all_files = list.files(path = Sys.getenv('REPORT_FILES_PATH'),
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
137 full.names = TRUE,
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
138 recursive = TRUE)
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
139
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
140 for (f in sub(Sys.getenv('REPORT_FILES_PATH'), '.', all_files) ) {
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
141 cat('* [', f, '](', f, ')\n')
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
142 }
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
143 cat('\n')
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
144 ```
d79569f269c7 planemo upload
mingchen0919
parents:
diff changeset
145