annotate helper.R @ 10:ec906e72784d draft

planemo upload commit e2f267840cded7ba17bb75a074796a4babbaab5b-dirty
author mingchen0919
date Thu, 26 Apr 2018 12:24:33 -0400
parents 578a96df8690
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
1 #' \code{getopt_specification_matrix} returns a getopt specification matrix.
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
2 #'
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
3 #' @param specification_file a cvs file within the \code{galaxy_tool_directory} which stores getopt specification matrix data.
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
4 #' The first column are short flags, the second column are argument masks, the third column
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
5 #' is data types. The fourth column are variable names used in the tool XML. These three columns are required.
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
6 #' @param gtg_name the name of a running GTG.
9
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
7 getopt_specification_matrix = function(specification_file,
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
8 gtg_name = 'gtg',
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
9 tool_dir = Sys.getenv('TOOL_DIR')) {
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
10 df = read.csv(
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
11 paste0(tool_dir, '/', specification_file),
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
12 header = TRUE,
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
13 stringsAsFactors = FALSE
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
14 )
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
15 # check if there are duplicated short flags
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
16 short_flags = df[, 1]
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
17 if (length(unique(short_flags)) < length(short_flags)) {
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
18 cat('----Duplicated short flags found ----\n')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
19 cat('short flags: ', df[, 1][duplicated(df[, 1])], '\n')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
20 stop('Duplicated short flags are not allowed.')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
21 }
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
22
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
23 # use short flags to generate long flags
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
24 long_flags = paste0('X_', df[, 1])
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
25
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
26 # specification matrix
9
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
27 df2 = data.frame(
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
28 long_flags = long_flags,
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
29 short_flags = df[, 1],
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
30 argument_mask = df[, 2],
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
31 data_type = df[, 3]
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
32 )
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
33
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
34 as.matrix(df2)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
35 }
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
36
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
37
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
38
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
39 #' \code{file_tree} generate file tree of a directory in the format of HTML lists.
9
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
40 #'
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
41 #' @param dir the path to the directory for generating the file tree.
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
42 #' @param output_dir the REPORT_FILES_PATH folder name, which has the name style: dataset_NUMBER_files.
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
43 # define a recursive function to build html string of the file tree
9
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
44 file_tree = function(dir = '.') {
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
45 # get the OUTPUT_DIR folder data: dataset_NUMBER_files
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
46 report_files_path = Sys.getenv('REPORT_FILES_PATH')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
47 output_dir = tail(strsplit(report_files_path, '/')[[1]], 1)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
48
9
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
49 files = list.files(path = dir,
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
50 recursive = FALSE,
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
51 full.names = TRUE)
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
52 # files also include directorys, need to remove directorys
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
53 files = files[!dir.exists(files)]
9
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
54 dirs = list.dirs(path = dir,
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
55 recursive = FALSE,
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
56 full.names = TRUE)
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
57 tags$ul({
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
58 if (length(files) > 0) {
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
59 lapply(files, function(x) {
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
60 path_end = tail(strsplit(x, '/')[[1]], 1)
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
61 href_path = strsplit(x, paste0(output_dir, '/'))[[1]][2]
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
62 li_item = tags$li(tags$a(path_end, href = href_path))
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
63 li_item$attribs = list('data-jstree' = '{"icon":"jstree-file"}')
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
64 li_item
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
65 })
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
66 }
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
67 },
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
68 {
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
69 if (length(dirs) > 0) {
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
70 lapply(dirs, function(x) {
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
71 path_end = tail(strsplit(x, '/')[[1]], 1)
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
72 # hide vakata-jstree-3.3.5 folder
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
73 if (path_end != 'vakata-jstree-3.3.5') {
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
74 # x_path = strsplit(x, paste0(output_dir, '/'))[[1]][2]
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
75 li_item = tags$li(path_end, file_tree(x))
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
76 li_item$attribs = list('data-jstree' = '{"icon":"jstree-folder"}')
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
77 li_item
9
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
78 }
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
79 })
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
80 }
9
578a96df8690 planemo upload commit 1cb2dd80dcb431563edbe1e763b3dde3a1adb2ae-dirty
mingchen0919
parents: 6
diff changeset
81 })
6
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
82 }