changeset 6:78044a3d4a21

Readme = wiki more or less now

--- a/README.txt	Thu May 31 09:50:47 2012 +1000
+++ b/README.txt	Thu May 31 10:49:22 2012 +1000
@@ -1,11 +1,13 @@
-After a lot of nagging about how hard it was to create new wrappers for trivial scripts, I wrote a new Galaxy tool (see the 
-source tab) locked down to allow only two other trusted bioinformatician users to paste and run (NO sandbox!) arbitrary 
-scripts - see screenshot attached. Note that this tool allows unrestricted access as user Galaxy so should be restricted to 
-admin users who could run rm -rf from a command line if they wanted to but can be trusted not to!
+= WARNING before you start =
+This tool should only ever be installed on a private instance - NEVER use it on a public Galaxy because the risks are too awful to contemplate let alone manage. You have been warned.
 
-For our group, this allows Galaxy to fill that important gap - all those "small" bioinformatics tasks that currently get run 
-outside Galaxy. Once a trusted user has a working R (or python or perl) script that takes parameters the way Galaxy supplies 
-them (see example below), they:
+== Motivation ==
+Simple transformation, filtering or reporting scripts get written, run and lost every day in most busy labs - even ours where Galaxy is in use. This 'dark script matter' is pervasive and generally not reproducible. 
+
+After considerable nagging, I wrote and installed a new tool locked down to allow only two other trusted bioinformatician users to paste and run (NO sandbox!) arbitrary scripts - see screenshot attached. 
+
+== Benefits ==
+For our group, this allows Galaxy to fill that important dark script gap - all those "small" bioinformatics tasks - because once a trusted user has a working R (or python or perl) script that takes parameters the way Galaxy supplies them (see example below), they: 
 
 1) run the new tool
 
@@ -15,30 +17,33 @@
 
 4) run the tool and thus the script. 
 
-Rerunning the output reruns the same script of course, so we're now better off than we were before. But what about adding 
-some code to this script runner tool to generate a new Galaxy tool as a ready to install toolshed entry? This (imho) will be 
-a very low impedence way to generate new simple Galaxy tools - run them until they work then package them up and 
-deploy/distribute for any user to use. The tool generator itself is dangerous but it could easily create normal Galaxy tools 
-with no new security risks - in the local toolshed!
+== Proposal - a Galaxy toolshed interface ==
+Rerunning the output of the existing script reruns the same script of course, so we're now better off than we were before. But what about adding some code to this script runner tool to generate a new Galaxy tool as a ready to install toolshed entry? 
+
+This (imho) will be a very low impedence way to generate new simple Galaxy tools - run them until they work then package them up and deploy/distribute for any user to use - no new security risks.
 
-That's the goal of this project.
+Does this seem like a good idea to anyone else?
 
-If this seem like a good idea to anyone else, please join in. First ticket - add a tool repository entry generator - is open 
-and waiting...
+== Proof of concept ==
 
-http://bitbucket.org/fubar/galaxytoolmaker/src/fda8032fe989/images/dynamicScriptTool.png is a proof of concept screengrab
+=== Obligatory screenshot ===
+[[http://bitbucket.org/fubar/galaxytoolmaker/src/fda8032fe989/images/dynamicScriptTool.png|proof of concept screengrab]]
 
-This trivial example script replaces the score column with a random number in a bed file using Rscript:
-
+=== Sample Rscript ===
+As a working example, this trivial Rscript replaces the score column in a bed file with a random number:
+{{{
   ourargs = commandArgs(TRUE)
-
   inf = ourargs[1]
-
   outf = ourargs[2]
-
   inp = read.table(inf,head=F,row.names=NULL,sep='\t')
-
   inp[,5] = runif ( nrow(inp) )
+  write.table(inp,outf, quote=FALSE, sep="\t",row.names=F,col.names=F)
+}}}
 
-  write.table(inp,outf, quote=FALSE, sep="\t",row.names=F,col.names=F)
+== Licensing ==
+All project artefacts are copyright Ross Lazarus (ross period lazarus at gmail period com) 2012
+All rights reserved.
+You may accept a license from me under the LGPL if you want to use this code for any reason.
+Please see http://www.gnu.org/licenses/lgpl.html for details
 
+