changeset 45:335e9eb25532 draft

planemo upload for repository https://github.com/statonlab/docker-GRReport/tree/master/my_tools/rmarkdown_collection_builder commit b15eec6b208c8a41b8ad8969ab9c6046d7f0b73c-dirty

--- a/collection_list.Rmd	Tue Sep 26 09:29:07 2017 -0400
+++ b/collection_list.Rmd	Tue Sep 26 12:04:54 2017 -0400
@@ -1,5 +1,5 @@
 ---
-title: 'Collection builder (collection type: list)'
+title: 'Build collection: a list of datasets'
 output:
     html_document:
       number_sections: true

--- a/collection_list_paired.Rmd	Tue Sep 26 09:29:07 2017 -0400
+++ b/collection_list_paired.Rmd	Tue Sep 26 12:04:54 2017 -0400
@@ -1,5 +1,5 @@
 ---
-title: 'Collection builder (collection type: list:paired)'
+title: 'Build collection: a list of paired datasets'
 output:
     html_document:
       number_sections: true
@@ -41,7 +41,7 @@
 original_files = list.files('./forward_files_directory')
 # create new files names from original file names
 new_files = gsub('\\.dat', '_forward\\.FORMAT', original_files)
-new_files = paste0('input', 1:length(original_files), '_forward.FORMAT')
+new_files = paste0('input_', 1:length(original_files), '_forward.FORMAT')
 new_files
 # rename files
 file.copy(paste0('./forward_files_directory/', original_files),
@@ -61,7 +61,7 @@
 original_files = list.files('./reverse_files_directory')
 # create new files names from original file names
 new_files = gsub('\\.dat', '_reverse\\.FORMAT', original_files)
-new_files = paste0('input', 1:length(original_files), '_reverse.FORMAT')
+new_files = paste0('input_', 1:length(original_files), '_reverse.FORMAT')
 new_files
 # rename files
 file.copy(paste0('./reverse_files_directory/', original_files),

--- a/collection_paired.Rmd	Tue Sep 26 09:29:07 2017 -0400
+++ b/collection_paired.Rmd	Tue Sep 26 12:04:54 2017 -0400
@@ -0,0 +1,29 @@
+---
+title: 'Build collection: a paired datasets'
+output:
+    html_document:
+      number_sections: true
+      toc: true
+      theme: cosmo
+      highlight: tango
+---
+
+```{r setup, include=FALSE, warning=FALSE, message=FALSE}
+knitr::opts_chunk$set(
+  echo = ECHO
+)
+```
+
+# Command line arguments
+
+```{r 'command line arguments'}
+str(opt)
+```
+
+# Rename files
+
+```{r}
+file.copy("FORWARD_INPUT", './files_directory/forward.FORMAT')
+file.copy("REVERSE_INPUT", './files_directory/reverse.FORMAT')
+```
+

--- a/collection_paired.xml	Tue Sep 26 09:29:07 2017 -0400
+++ b/collection_paired.xml	Tue Sep 26 12:04:54 2017 -0400
@@ -26,8 +26,8 @@
     <command>
         <![CDATA[
             Rscript '${__tool_directory__}/collection_paired_render.R'
-                -L $forward_file_list
-                -R $reverse_file_list
+                -L $forward_input
+                -R $reverse_input
                 -e $echo
                 -f $format
 
@@ -38,16 +38,17 @@
         ]]>
     </command>
     <inputs>
-        <param type="data" name="forward_file_list" multiple="true" label="forward inputs"/>
-        <param type="data" name="reverse_file_list" multiple="true" label="reverse inputs"/>
-        <param type="text" name="format" label="the format of input files (e.g., fastq, fastqsanger, fasta)"/>
+        <param type="data" name="forward_input" multiple="true" label="forward input"/>
+        <param type="data" name="reverse_input" multiple="true" label="reverse input"/>
+        <param type="text" name="format" label="the format (extension) of input files (e.g., fastq, fastqsanger, fasta)"/>
 
         <param type="boolean" name="echo" truevalue="TRUE" falsevalue="FALSE" checked="false" label="Display analysis code in report?" />
     </inputs>
     <outputs>
         <data format="html" name="report" label="Collection builder (paired collection)" />
         <collection type="paired" name="list_collection">
-            <discover_datasets pattern="(?P&lt;identifier_0&gt;[^_]+)_(?P&lt;identifier_1&gt;[^_]+)\.(?P<ext>[^\._]+)?" directory="files_directory"/>
+            <element name="forward" value="forward.${format}" />
+            <element name="reverse" value="reverse.${format}" />
         </collection>
     </outputs>
 </tool>
\ No newline at end of file

--- a/collection_paired_render.R	Tue Sep 26 09:29:07 2017 -0400
+++ b/collection_paired_render.R	Tue Sep 26 12:04:54 2017 -0400
@@ -0,0 +1,85 @@
+##======= Handle arguments from command line ========
+# setup R error handline to go to stderr
+options(show.error.messages=FALSE,
+        error=function(){
+          cat(geterrmessage(), file=stderr())
+          quit("no", 1, F)
+        })
+
+# we need that to not crash galaxy with an UTF8 error on German LC settings.
+loc = Sys.setlocale("LC_MESSAGES", "en_US.UTF-8")
+
+# suppress warning
+options(warn = -1)
+
+options(stringsAsFactors=FALSE, useFancyQuotes=FALSE)
+args = commandArgs(trailingOnly=TRUE)
+
+suppressPackageStartupMessages({
+  library(getopt)
+  library(tools)
+})
+
+# column 1: the long flag name
+# column 2: the short flag alias. A SINGLE character string
+# column 3: argument mask
+#           0: no argument
+#           1: argument required
+#           2: argument is optional
+# column 4: date type to which the flag's argument shall be cast.
+#           possible values: logical, integer, double, complex, character.
+##------- 1. input data ---------------------
+spec_list=list()
+spec_list$FORWARD_INPUT = c('forward_input', 'L', '1', 'character')
+spec_list$REVERSE_INPUT = c('reverse_forward_input', 'R', '1', 'character')
+spec_list$ECHO = c('echo', 'e', '1', 'character')
+spec_list$FORMAT = c('format', 'f', '1', 'character')
+##--------2. output report and outputs --------------
+spec_list$OUTPUT_HTML = c('list_paired_collection_html', 'r', '1', 'character')
+spec_list$OUTPUT_DIR = c('list_paired_collection_dir', 'd', '1', 'character')
+##--------3. Rmd templates in the tool directory ----------
+spec_list$LIST_COLLECTION_RMD = c('list_collection_rmd', 't', '1', 'character')
+
+spec = t(as.data.frame(spec_list))
+opt = getopt(spec)
+##====== End of arguments handling ==========
+
+#------ Load libraries ---------
+library(rmarkdown)
+library(htmltools)
+library(dplyr)
+
+#----- 1. create the report directory ------------------------
+system(paste0('mkdir -p ', opt$list_paired_collection_dir))
+
+#----- 2. generate Rmd files with Rmd templates --------------
+#   a. templates without placeholder variables:
+#         copy templates from tool directory to the working directory.
+#   b. templates with placeholder variables:
+#         substitute variables with user input values and place them in the working directory.
+
+#----- 01 list_collection.Rmd -----------------------
+readLines(opt$list_collection_rmd) %>%
+  (function(x) {
+    gsub('ECHO', opt$echo, x)
+  }) %>%
+  (function(x) {
+    gsub('FORMAT', opt$format, x)
+  }) %>%
+  (function(x) {
+    gsub('FORWARD_INPUT', opt$forward_input, x)
+  }) %>%
+  (function(x) {
+    gsub('REVERSE_INPUT', opt$reverse_forward_input, x)
+  }) %>%
+  (function(x) {
+    fileConn = file('list_paired_collection.Rmd')
+    writeLines(x, con=fileConn)
+    close(fileConn)
+  })
+
+#------ 3. render all Rmd files --------
+render('list_paired_collection.Rmd', output_file = opt$list_paired_collection_html)
+
+
+#-------4. manipulate outputs -----------------------------