Mercurial > repos > mingchen0919 > aurora_skewer

changeset 5:2c663ddb8488 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit f0ae5255b6c75f69c85319bba8da742be83f27d2-dirty
author mingchen0919
date Wed, 25 Apr 2018 16:47:59 -0400
parents c7de860e5be7
children 5b07e567864b
files expose-outputs.sh helper.R run-skewer-job.sh shell-script-template.sh skewer.Rmd skewer_render.R
diffstat 6 files changed, 151 insertions(+), 115 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/expose-outputs.sh	Wed Apr 25 16:47:59 2018 -0400
@@ -0,0 +1,17 @@
+# change directory to tool outputs directory
+cd ${REPORT_FILES_PATH}
+
+# copy outputs from tool outputs directory to corresponding galaxy output path
+cp skewer.html ${REPORT}
+
+if [ -e trim-trimmed-pair1.fastq ]; then
+  cp trim-trimmed-pair1.fastq ${X_1}
+fi
+
+if [ -e trim-trimmed-pair2.fastq ]; then
+  cp trim-trimmed-pair2.fastq ${X_2}
+fi
+
+if [ -e trim-trimmed.fastq ]; then
+  cp trim-trimmed.fastq ${X_3}
+fi
--- a/helper.R	Wed Apr 18 10:03:56 2018 -0400
+++ b/helper.R	Wed Apr 25 16:47:59 2018 -0400
@@ -4,9 +4,14 @@
 #' The first column are short flags, the second column are argument masks, the third column
 #' is data types. The fourth column are variable names used in the tool XML. These three columns are required.
 #' @param gtg_name the name of a running GTG.
-getopt_specification_matrix = function(specification_file, gtg_name = 'gtg', tool_dir = Sys.getenv('TOOL_DIR')) {
-  df = read.csv(paste0(tool_dir, '/', specification_file),
-                header = TRUE, stringsAsFactors = FALSE)
+getopt_specification_matrix = function(specification_file,
+                                       gtg_name = 'gtg',
+                                       tool_dir = Sys.getenv('TOOL_DIR')) {
+  df = read.csv(
+    paste0(tool_dir, '/', specification_file),
+    header = TRUE,
+    stringsAsFactors = FALSE
+  )
   # check if there are duplicated short flags
   short_flags = df[, 1]
   if (length(unique(short_flags)) < length(short_flags)) {
@@ -19,10 +24,12 @@
   long_flags = paste0('X_', df[, 1])
   
   # specification matrix
-  df2 = data.frame(long_flags = long_flags,
-                   short_flags = df[, 1],
-                   argument_mask = df[, 2],
-                   data_type = df[, 3])
+  df2 = data.frame(
+    long_flags = long_flags,
+    short_flags = df[, 1],
+    argument_mask = df[, 2],
+    data_type = df[, 3]
+  )
   
   as.matrix(df2)
 }
@@ -30,43 +37,46 @@
 
 
 #' \code{file_tree} generate file tree of a directory in the format of HTML lists.
-#' 
+#'
 #' @param dir the path to the directory for generating the file tree.
 #' @param output_dir the REPORT_FILES_PATH folder name, which has the name style: dataset_NUMBER_files.
 # define a recursive function to build html string of the file tree
-file_tree = function(dir = '.'){
+file_tree = function(dir = '.') {
   # get the OUTPUT_DIR folder data: dataset_NUMBER_files
   report_files_path = Sys.getenv('REPORT_FILES_PATH')
   output_dir = tail(strsplit(report_files_path, '/')[[1]], 1)
   
-  files = list.files(path = dir, recursive = FALSE, full.names = TRUE)
+  files = list.files(path = dir,
+                     recursive = FALSE,
+                     full.names = TRUE)
   # files also include directorys, need to remove directorys
   files = files[!dir.exists(files)]
-  dirs = list.dirs(path = dir, recursive = FALSE, full.names = TRUE)
-  # hide vakata-jstree-3.3.5 folder
-  #jstree_index = grep(pattern = 'vakata-jstree-3.3.5', x = dirs)
-  #dirs = dirs[-jstree_index]
-  tags$ul(
-    {
-      if (length(files) > 0) {
-        lapply(files, function(x){
-          path_end = tail(strsplit(x, '/')[[1]],1)
-          href_path = strsplit(x, paste0(output_dir, '/'))[[1]][2]
-          li_item = tags$li(tags$a(path_end, href=href_path))
-          li_item$attribs = list('data-jstree'='{"icon":"jstree-file"}')
+  dirs = list.dirs(path = dir,
+                   recursive = FALSE,
+                   full.names = TRUE)
+  tags$ul({
+    if (length(files) > 0) {
+      lapply(files, function(x) {
+        path_end = tail(strsplit(x, '/')[[1]], 1)
+        href_path = strsplit(x, paste0(output_dir, '/'))[[1]][2]
+        li_item = tags$li(tags$a(path_end, href = href_path))
+        li_item$attribs = list('data-jstree' = '{"icon":"jstree-file"}')
+        li_item
+      })
+    }
+  },
+  {
+    if (length(dirs) > 0) {
+      lapply(dirs, function(x) {
+        path_end = tail(strsplit(x, '/')[[1]], 1)
+        # hide vakata-jstree-3.3.5 folder
+        if (path_end != 'vakata-jstree-3.3.5') {
+          # x_path = strsplit(x, paste0(output_dir, '/'))[[1]][2]
+          li_item = tags$li(path_end, file_tree(x))
+          li_item$attribs = list('data-jstree' = '{"icon":"jstree-folder"}')
           li_item
-        })
-      }
-    },
-    {
-      if (length(dirs) > 0) {
-        lapply(dirs, function(x){
-          x_path = strsplit(x, paste0(output_dir, '/'))[[1]][2]
-          li_item = tags$li(x_path, file_tree(x))
-          li_item$attribs = list('data-jstree'='{"icon":"jstree-folder"}')
-          li_item
-        })
-      }
+        }
+      })
     }
-  )
+  })
 }
--- a/run-skewer-job.sh	Wed Apr 18 10:03:56 2018 -0400
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,59 +0,0 @@
-#--- build skewer job script ---
-## change directory to output dir
-cd ${X_d}
-
-cat >temp.sh <<EOL
-skewer \\
-	${X_A} \\
-	${X_B} \\
-	-x ${X_x} \\ 
-	-y ${X_y} \\
-	-m ${X_m} \\
-	-r ${X_r} \\
-	-d ${X_D} \\
-	-q ${X_q} \\
-	-Q ${X_Q} \\
-	-l ${X_l} \\
-	-j ${X_j} \\
-	-M ${X_M} \\
-	-b ${X_b} \\
-	-c ${X_b} \\
-	-n ${X_n} \\
-	-u ${X_u} \\
-	-f ${X_f} \\
-	-z ${X_z} \\
-	-qiime ${X_E} \\
-	-quiet ${X_F} \\
-	-i ${X_i} \\
-	-o trim > /dev/null 2>&1
-
-EOL
-
-# remove empty input lines
-grep -v '\-M  \\' temp.sh |\
-  grep -v 'None' |\
-  grep -v 'NO_ARGUMENT_NO' |\
-  sed 's/NO_ARGUMENT_YES//g' > skewer-job.sh
-
-sh skewer-job.sh
-
-# expose files to galaxy history
-if [ -e trim-trimmed-pair1.fastq ]; then
-  cp trim-trimmed-pair1.fastq ${X_1}
-fi
-
-if [ -e trim-trimmed-pair2.fastq ]; then
-  cp trim-trimmed-pair2.fastq ${X_2}
-fi
-
-if [ -e trim-trimmed.fastq ]; then
-  cp trim-trimmed.fastq ${X_3}
-fi
-
-# rename log file
-if [ -e trim-trimmed.log ]; then
-  cp trim-trimmed.log trim-trimmed.txt
-fi
-
-# remove temp.sh
-rm temp.sh
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/shell-script-template.sh	Wed Apr 25 16:47:59 2018 -0400
@@ -0,0 +1,48 @@
+# SHELL_SCRIPT file name
+SHELL_SCRIPT='skewer.sh'
+
+# run SHELL_SCRIPT within tool outputs directory
+cd ${REPORT_FILES_PATH}
+
+# build job-script.sh
+cat >temp.sh <<EOF
+skewer \\
+	${X_A} \\
+	${X_B} \\
+	-x ${X_x} \\ 
+	-y ${X_y} \\
+	-m ${X_m} \\
+	-r ${X_r} \\
+	-d ${X_D} \\
+	-q ${X_q} \\
+	-Q ${X_Q} \\
+	-l ${X_l} \\
+	-j ${X_j} \\
+	-M ${X_M} \\
+	-b ${X_b} \\
+	-c ${X_b} \\
+	-n ${X_n} \\
+	-u ${X_u} \\
+	-f ${X_f} \\
+	-z ${X_z} \\
+	-qiime ${X_E} \\
+	-quiet ${X_F} \\
+	-i ${X_i} \\
+	-o trim > /dev/null 2>&1 
+EOF
+
+# remove empty input lines
+grep -v '\-M  \\' temp.sh |\
+  grep -v 'None' |\
+  grep -v 'NO_ARGUMENT_NO' |\
+  sed 's/NO_ARGUMENT_YES//g' > ${SHELL_SCRIPT}
+
+rm temp.sh
+
+# run SHELL_SCRIPT
+sh ${SHELL_SCRIPT}
+
+# rename log file
+if [ -e trim-trimmed.log ]; then
+  cp trim-trimmed.log trim-trimmed.txt
+fi
\ No newline at end of file
--- a/skewer.Rmd	Wed Apr 18 10:03:56 2018 -0400
+++ b/skewer.Rmd	Wed Apr 25 16:47:59 2018 -0400
@@ -39,17 +39,31 @@
     });
   });
 </script>
+
+```{css}
+# code chunks scrollable
+pre code, pre, code {
+  white-space: pre !important;
+  overflow-x: scroll !important;
+  word-break: keep-all !important;
+  word-wrap: initial !important;
+}
+```
 -----------------------------------------
 
-
-
-```{bash echo=FALSE}
-sh ${TOOL_INSTALL_DIR}/run-skewer-job.sh
-```
-
 ## Job script
 
-* [skewer-job.sh](skewer-job.sh)
+```{bash echo=FALSE}
+sh ${TOOL_INSTALL_DIR}/shell-script-template.sh
+```
+
+```{r echo=FALSE,warning=FALSE,results='asis'}
+# display content of the job-script.sh file.
+cat('```bash\n')
+cat(readLines(paste0(Sys.getenv('REPORT_FILES_PATH'), '/skewer.sh')), sep = '\n')
+cat('\n```')
+```
+
 
 -----------------------------------------
 ## Output
--- a/skewer_render.R	Wed Apr 18 10:03:56 2018 -0400
+++ b/skewer_render.R	Wed Apr 25 16:47:59 2018 -0400
@@ -5,40 +5,46 @@
 sink(zz)
 sink(zz, type = 'message')
 
-#-------------------preparation -----------------
+#============== preparation ====================================
 options(stringsAsFactors = FALSE)
 # import libraries
-library(getopt)
-library(rmarkdown)
-library(htmltools)
+#------------------------------------------------------------------
+# ADD MORE LIBRARIES HERE IF YOUR TOOL DEPENDS ON OTHER R LIBRARIES
+#------------------------------------------------------------------
+library('getopt')
+library('rmarkdown')
+library('htmltools')
+
+
 # load helper functions
 source(paste0(Sys.getenv('TOOL_INSTALL_DIR'), '/helper.R'))
 # import getopt specification matrix from a csv file
 opt = getopt(getopt_specification_matrix('getopt_specification.csv', 
                                          tool_dir=Sys.getenv('TOOL_INSTALL_DIR')))
-# define a unix variable versions for all input values. this is useful when we 
+# define environment variables for all input values. this is useful when we 
 # want to use input values by other programming language in r markdown
 do.call(Sys.setenv, opt[-1])
-#------------------------------------------------
+#===============================================================
 
 
-
-
-#-----------------render Rmd files --------------
+#======================== render Rmd files =========================
 # NOTICE: 
 #       we should copy all rmarkdown files from tool install directory to REPORT_FILES_PATH directory.
 #       and render rmarkdown files in the REPORT_FILES_PATH directory.
 file.copy(from = paste0(Sys.getenv('TOOL_INSTALL_DIR'), '/vakata-jstree-3.3.5'),
           to = Sys.getenv('REPORT_FILES_PATH'), recursive = TRUE)
 system(command = 'cp -r ${TOOL_INSTALL_DIR}/*.Rmd ${REPORT_FILES_PATH}')
-# render Rmd files in order
+
+#----------------BELOW IS WHERE YOU NEED TO CUSTOMIZE ---------------------
 render(input = paste0(Sys.getenv('REPORT_FILES_PATH'), '/skewer.Rmd'))
-#------------------------------------------
+# add more lines below if there are more Rmd files to be rendered
+
+#===============================================================
 
 
-#---------------- copy the output html to REPORT ----
-system(command = 'cp ${REPORT_FILES_PATH}/skewer.html ${REPORT}')
-#==============the end==============
+#============== expose outputs to galaxy history ===============
+system(command = 'sh ${TOOL_INSTALL_DIR}/expose-outputs.sh')
+#===============================================================
 
 
 ##--------end of code rendering .Rmd templates----------------