annotate helper.R @ 8:1696f5ee0fe7 draft

remove kableextra package
author mingchen0919
date Wed, 18 Apr 2018 17:12:06 -0400
parents 7c54fd452b8e
children 578a96df8690
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.
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
7 getopt_specification_matrix = function(specification_file, gtg_name = 'gtg', tool_dir = Sys.getenv('TOOL_DIR')) {
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
8 df = read.csv(paste0(tool_dir, '/', specification_file),
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
9 header = TRUE, stringsAsFactors = FALSE)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
10 # check if there are duplicated short flags
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
11 short_flags = df[, 1]
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
12 if (length(unique(short_flags)) < length(short_flags)) {
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
13 cat('----Duplicated short flags found ----\n')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
14 cat('short flags: ', df[, 1][duplicated(df[, 1])], '\n')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
15 stop('Duplicated short flags are not allowed.')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
16 }
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
17
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
18 # use short flags to generate long flags
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
19 long_flags = paste0('X_', df[, 1])
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
20
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
21 # specification matrix
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
22 df2 = data.frame(long_flags = long_flags,
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
23 short_flags = df[, 1],
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
24 argument_mask = df[, 2],
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
25 data_type = df[, 3])
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
26
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
27 as.matrix(df2)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
28 }
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
29
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
30
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
31
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
32 #' \code{file_tree} generate file tree of a directory in the format of HTML lists.
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
33 #'
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
34 #' @param dir the path to the directory for generating the file tree.
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
35 #' @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
36 # define a recursive function to build html string of the file tree
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
37 file_tree = function(dir = '.'){
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
38 # get the OUTPUT_DIR folder data: dataset_NUMBER_files
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
39 report_files_path = Sys.getenv('REPORT_FILES_PATH')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
40 output_dir = tail(strsplit(report_files_path, '/')[[1]], 1)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
41
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
42 files = list.files(path = dir, recursive = FALSE, full.names = TRUE)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
43 # files also include directorys, need to remove directorys
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
44 files = files[!dir.exists(files)]
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
45 dirs = list.dirs(path = dir, recursive = FALSE, full.names = TRUE)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
46 # hide vakata-jstree-3.3.5 folder
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
47 #jstree_index = grep(pattern = 'vakata-jstree-3.3.5', x = dirs)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
48 #dirs = dirs[-jstree_index]
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
49 tags$ul(
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
50 {
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
51 if (length(files) > 0) {
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
52 lapply(files, function(x){
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
53 path_end = tail(strsplit(x, '/')[[1]],1)
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
54 href_path = strsplit(x, paste0(output_dir, '/'))[[1]][2]
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
55 li_item = tags$li(tags$a(path_end, href=href_path))
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
56 li_item$attribs = list('data-jstree'='{"icon":"jstree-file"}')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
57 li_item
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
58 })
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
59 }
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
60 },
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
61 {
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
62 if (length(dirs) > 0) {
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
63 lapply(dirs, function(x){
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
64 x_path = strsplit(x, paste0(output_dir, '/'))[[1]][2]
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
65 li_item = tags$li(x_path, file_tree(x))
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
66 li_item$attribs = list('data-jstree'='{"icon":"jstree-folder"}')
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
67 li_item
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
68 })
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
69 }
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
70 }
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
71 )
7c54fd452b8e add kableExtra package
mingchen0919
parents:
diff changeset
72 }