# HG changeset patch
# User fubar_too
# Date 1625118727 0
# Node ID 7596aa302d6081fbecdd2c36cded1aac54a6f537
# Parent 312eb2aaf31386f515fcf8c17b3a2955170d8ae5
Uploaded
diff -r 312eb2aaf313 -r 7596aa302d60 toolfactory/LICENSE
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/toolfactory/LICENSE Thu Jul 01 05:52:07 2021 +0000
@@ -0,0 +1,504 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+(This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.)
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+not price. Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Libraries
+
+ If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+ To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ {description}
+ Copyright (C) {year} {fullname}
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
+ USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random
+ Hacker.
+
+ {signature of Ty Coon}, 1 April 1990
+ Ty Coon, President of Vice
+
+That's all there is to it!
diff -r 312eb2aaf313 -r 7596aa302d60 toolfactory/README.md
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/toolfactory/README.md Thu Jul 01 05:52:07 2021 +0000
@@ -0,0 +1,378 @@
+## Breaking news! Completely refactored
+
+### New demonstration of planemo tool_factory command 
+
+# WARNING
+
+Install this tool to a throw-away private Galaxy or Docker container ONLY!
+
+Please NEVER on a public or production instance where a hostile user may
+be able to gain access if they can acquire an administrative account login.
+
+It only runs for server administrators - the ToolFactory tool will refuse to execute for an ordinary user since
+it can install new tools to the Galaxy server it executes on! This is not something you should allow other than
+on a throw away instance that is protected from potentially hostile users.
+
+## Short Story
+
+Galaxy is easily extended to new applications by adding a new tool. Each new scientific computational package added as
+a tool to Galaxy requires an XML document describing how the application interacts with Galaxy.
+This is sometimes termed "wrapping" the package because the instructions tell Galaxy how to run the package
+as a new Galaxy tool. Any tool that has been wrapped is readily available to all the users through a consistent
+and easy to use interface once installed in the local Galaxy server.
+
+Most Galaxy tool wrappers have been manually prepared by skilled programmers, many using Planemo because it
+automates much of the boilerplate and makes the process much easier.
+The ToolFactory (TF) now uses Planemo under the hood for testing, but hides the command
+line complexities. The user will still need appropriate skills in terms of describing the interface between
+Galaxy and the new application, but will be helped by a Galaxy tool form to collect all the needed
+settings, together with automated testing and uploading to a toolshed with optional local installation.
+
+
+## ToolFactory generated tools are ordinary Galaxy tools
+
+A TF generated tool that passes the Planemo test is ready to publish in any Galaxy Toolshed and ready to install in any running Galaxy instance.
+They are fully workflow compatible and work exactly like any hand-written tool. The user can select input files of the specified type(s) from their
+history and edit each of the specified parameters. The tool form will show all the labels and help text supplied when the tool was built. When the tool
+is executed, the dependent binary or script will be passed all the i/o files and parameters as specified, and will write outputs to the specified new
+history datasets - just like any other Galaxy tool.
+
+## Models for tool command line construction
+
+The key to turning any software package into a Galaxy tool is the automated construction of a suitable command line.
+
+The TF can build a new tool that will allow the tool user to select input files from their history, set any parameters and when run will send the
+new output files to the history as specified when the tool builder completed the form and built the new tool.
+
+That tool can contain instructions to run any Conda dependency or a system executable like bash. Whether a bash script you have written or
+a Conda package like bwa, the executable will expect to find settings for input, output and parameters on a command line.
+
+These are often passed as "--name value" (argparse style) or in a fixed order (positional style).
+
+The ToolFactory allows either, or for "filter" applications that process input from STDIN and write processed output to STDOUT.
+
+The simplest tool model wraps a simple script or Conda dependency package requiring only input and output files, with no user supplied settings illustrated by
+the Tacrev demonstration tool found in the Galaxy running in the ToolFactory docker container. It passes a user selected input file from the current history on STDIN
+to a bash script. The bash script runs the unix tac utility (reverse cat) piped to the unix rev (reverse lines in a text file) utility. It's a one liner:
+
+`tac | rev`
+
+The tool building form allows zero or more Conda package name(s) and version(s) and an optional script to be executed by either a system
+executable like ``bash`` or the first of any named Conda dependency package/version. Tacrev uses a tiny bash script shown above and uses the system
+bash. Conda bash can be specified if it is important to use the same version consistently for the tool.
+
+On the tool form, the repeat section allowing zero or more input files was set to be a text file to be selected by the tool user and
+in the repeat section allowing one or more outputs, a new output file with special value `STDOUT` as the positional parameter, causes the TF to
+generate a command to capture STDOUT and send it to the new history file containing the reversed input text.
+
+By reversed, we mean really, truly reversed.
+
+That simple model can be made much more complicated, and can pass inputs and outputs as named or positional parameters,
+to allow more complicated scripts or dependent binaries that require:
+
+1. Any number of input data files selected by the user from existing history data
+2. Any number of output data files written to the user's history
+3. Any number of user supplied parameters. These can be passed as command line arguments to the script or the dependency package. Either
+positional or named (argparse) style command line parameter passing can be used.
+
+More complex models can be seen in the Sedtest, Pyrevpos and Pyrevargparse tools illustrating positional and argparse parameter passing.
+
+The most complex demonstration is the Planemo advanced tool tutorial BWA tool. There is one version using a command-override to implement
+exactly the same command structure in the Planemo tutorial. A second version uses a bash script and positional parameters to achieve the same
+result. Some tool builders may find the bash version more familiar and cleaner but the choice is yours.
+
+## Overview
+
+
+
+
+Steps in building a new Galaxy tool are all conducted through Galaxy running in the docker container:
+
+1. Login to the Galaxy running in the container at http://localhost:8080 using an admin account. They are specified in config/galaxy.yml and
+ in the documentation at
+ and the ToolFactory will error out and refuse to run for non-administrative tool builders as a minimal protection from opportunistic hostile use.
+
+2. Start the TF and fill in the form, providing sample inputs and parameter values to suit the Conda package being wrapped.
+
+3. Execute the tool to create a new XML tool wrapper using the sample inputs and parameter settings for the inbuilt tool test. Planemo runs twice.
+ firstly to generate the test outputs and then to perform a proper test. The completed toolshed archive is written to the history
+ together with the planemo test report. Optionally the new tool archive can be uploaded
+ to the toolshed running in the same container (http://localhost:9009) and then installed inside the Galaxy in the container for further testing.
+
+4. If the test fails, rerun the failed history job and correct errors on the tool form before rerunning until everything works correctly.
+
+
+
+## Planning and building new Galaxy tool wrappers.
+
+It is best to have all the required planning done to wrap any new script or binary before firing up the TF.
+Conda is the only current dependency manager supported. Before starting, at the very least, the tool builder will need
+to know the required software package name in Conda and the version to use, how the command line for
+the package must be constructed, and there must be sample inputs in the working history for each of the required data inputs
+for the package, together with values for every parameter to suit these sample inputs. These are required on the TF form
+for preparing the inbuilt tool test. That test is run using Planemo, as part of the tool generation process.
+
+A new tool is specified by filling in the usual Galaxy tool form.
+
+The form starts with a new tool name. Most tools will need dependency packages and versions
+for the executable. Only Conda is currently supported.
+
+If a script is needed, it can be pasted into a text box and the interpreter named. Available system executables
+can be used such as bash, or an interpreter such as python, perl or R can be nominated as conda dependencies
+to ensure reproducible analyses.
+
+The tool form will be generated from the input data and the tool builder supplied parameters. The command line for the
+executable is built using positional or argparse (named e.g. --input_file /foo/baz) style
+parameters and is completely dependent on the executable. These can include:
+
+1. Any number of input data sets needed by the executable. Each appears to the tool user on the run form and is included
+on the command line for the executable. The tool builder must supply a small representative sample for each one as
+an input for the automated tool test.
+
+2. Any number of output data sets generated by the package can be added to the command line and will appear in
+the user's history at the end of the job
+
+3. Any number of text or numeric parameters. Each will appear to the tool user on the run form and are included
+on the command line to the executable. The tool builder must supply a suitable representative value for each one as
+the value to be used for the automated tool test.
+
+Once the form is completed, executing the TF will build a new XML tool wrapper
+including a functional test based on the sample settings and data.
+
+If the Planemo test passes, the tool can be optionally uploaded to the local Galaxy used in the image for more testing.
+
+A local toolshed runs inside the container to allow an automated installation, although any toolshed and any accessible
+Galaxy can be specified for this process by editing the default URL and API keys to provide appropriate credentials.
+
+## Generated Tool Dependency management
+
+Conda is used for all dependency management although tools that use system utilities like sed, bash or awk
+may be available on job execution nodes. Sed and friends are available as Conda (conda-forge) dependencies if necessary.
+Versioned Conda dependencies are always baked-in to the tool and will be used for reproducible calculation.
+
+## Requirements
+
+These are all managed automagically. The TF relies on galaxyxml to generate tool xml and uses ephemeris and
+bioblend to load tools to the toolshed and to Galaxy. Planemo is used for testing and runs in a biocontainer currently at
+https://quay.io/fubar2/planemo-biocontainer
+
+## Caveats
+
+This docker image requires privileged mode so exposes potential security risks if hostile tool builders gain access.
+Please, do not run it in any situation where that is a problem - never, ever on a public facing Galaxy server.
+On a laptop or workstation should be fine in a non-hostile environment.
+
+
+## Example generated XML
+
+For the bwa-mem example, a supplied bash script is included as a configfile and so has escaped characters.
+```
+
+
+
+
+ Planemo advanced tool building sample bwa mem mapper as a ToolFactory demo
+
+ bwa
+ samtools
+
+
+ tempsam
+samtools view -Sb tempsam > temporary_bam_file.bam
+samtools sort -o "\$BAMOUT" temporary_bam_file.bam
+
+]]>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ tempsam
+ samtools view -Sb tempsam > temporary_bam_file.bam
+ samtools sort -o "$BAMOUT" temporary_bam_file.bam
+
+]]>
+
+
+```
+
+
+
+## More Explanation
+
+The TF is an unusual Galaxy tool, designed to allow a skilled user to make new Galaxy tools.
+It appears in Galaxy just like any other tool but outputs include new Galaxy tools generated
+using instructions provided by the user and the results of Planemo lint and tool testing using
+small sample inputs provided by the TF user. The small samples become tests built in to the new tool.
+
+It offers a familiar Galaxy form driven way to define how the user of the new tool will
+choose input data from their history, and what parameters the new tool user will be able to adjust.
+The TF user must know, or be able to read, enough about the tool to be able to define the details of
+the new Galaxy interface and the ToolFactory offers little guidance on that other than some examples.
+
+Tools always depend on other things. Most tools in Galaxy depend on third party
+scientific packages, so TF tools usually have one or more dependencies. These can be
+scientific packages such as BWA or scripting languages such as Python and are
+managed by Conda. If the new tool relies on a system utility such as bash or awk
+where the importance of version control on reproducibility is low, these can be used without
+Conda management - but remember the potential risks of unmanaged dependencies on computational
+reproducibility.
+
+The TF user can optionally supply a working script where scripting is
+required and the chosen dependency is a scripting language such as Python or a system
+scripting executable such as bash. Whatever the language, the script must correctly parse the command line
+arguments it receives at tool execution, as they are defined by the TF user. The
+text of that script is "baked in" to the new tool and will be executed each time
+the new tool is run. It is highly recommended that scripts and their command lines be developed
+and tested until proven to work before the TF is invoked. Galaxy as a software development
+environment is actually possible, but not recommended being somewhat clumsy and inefficient.
+
+Tools nearly always take one or more data sets from the user's history as input. TF tools
+allow the TF user to define what Galaxy datatypes the tool end user will be able to choose and what
+names or positions will be used to pass them on a command line to the package or script.
+
+Tools often have various parameter settings. The TF allows the TF user to define how each
+parameter will appear on the tool form to the end user, and what names or positions will be
+used to pass them on the command line to the package. At present, parameters are limited to
+simple text and number fields. Pull requests for other kinds of parameters that galaxyxml
+can handle are welcomed.
+
+Best practice Galaxy tools have one or more automated tests. These should use small sample data sets and
+specific parameter settings so when the tool is tested, the outputs can be compared with their expected
+values. The TF will automatically create a test for the new tool. It will use the sample data sets
+chosen by the TF user when they built the new tool.
+
+The TF works by exposing *unrestricted* and therefore extremely dangerous scripting
+to all designated administrators of the host Galaxy server, allowing them to
+run scripts in R, python, sh and perl. For this reason, a Docker container is
+available to help manage the associated risks.
+
+## Scripting uses
+
+To use a scripting language to create a new tool, you must first prepared and properly test a script. Use small sample
+data sets for testing. When the script is working correctly, upload the small sample datasets
+into a new history, start configuring a new ToolFactory tool, and paste the script into the script text box on the TF form.
+
+### Outputs
+
+The TF will generate the new tool described on the TF form, and test it
+using planemo. Optionally if a local toolshed is running, it can be used to
+install the new tool back into the generating Galaxy.
+
+A toolshed is built in to the Docker container and configured
+so a tool can be tested, sent to that toolshed, then installed in the Galaxy
+where the TF is running using the default toolshed and Galaxy URL and API keys.
+
+Once it's in a ToolShed, it can be installed into any local Galaxy server
+from the server administrative interface.
+
+Once the new tool is installed, local users can run it - each time, the
+package and/or script that was supplied when it was built will be executed with the input chosen
+from the user's history, together with user supplied parameters. In other words, the tools you generate with the
+TF run just like any other Galaxy tool.
+
+TF generated tools work as normal workflow components.
+
+
+## Limitations
+
+The TF is flexible enough to generate wrappers for many common scientific packages
+but the inbuilt automation will not cope with all possible situations. Users can
+supply overrides for two tool XML segments - tests and command and the BWA
+example in the supplied samples workflow illustrates their use. It does not deal with
+repeated elements or conditional parameters such as allowing a user to choose to see "simple"
+or "advanced" parameters (yet) and there will be plenty of packages it just
+won't cover - but it's a quick and efficient tool for the other 90% of cases. Perfect for
+that bash one liner you need to get that workflow functioning correctly for this
+afternoon's demonstration!
+
+## Installation
+
+The Docker container https://github.com/fubar2/toolfactory-galaxy-docker/blob/main/README.md
+is the best way to use the TF because it is preconfigured
+to automate new tool testing and has a built in local toolshed where each new tool
+is uploaded. If you grab the docker container, it should just work after a restart and you
+can run a workflow to generate all the sample tools. Running the samples and rerunning the ToolFactory
+jobs that generated them allows you to add fields and experiment to see how things work.
+
+It can be installed like any other tool from the Toolshed, but you will need to make some
+configuration changes (TODO write a configuration). You can install it most conveniently using the
+administrative "Search and browse tool sheds" link. Find the Galaxy Main
+toolshed at https://toolshed.g2.bx.psu.edu/ and search for the toolfactory
+repository in the Tool Maker section. Open it and review the code and select the option to install it.
+
+If not already there please add:
+
+```
+
+```
+
+to your local config/data_types_conf.xml.
+
+
+## Restricted execution
+
+The tool factory tool itself will ONLY run for admin users -
+people with IDs in config/galaxy.yml "admin_users".
+
+*ONLY admin_users can run this tool*
+
+That doesn't mean it's safe to install on a shared or exposed instance - please don't.
+
+## Generated tool Security
+
+Once you install a generated tool, it's just
+another tool - assuming the script is safe. They just run normally and their
+user cannot do anything unusually insecure but please, practice safe toolshed.
+Read the code before you install any tool. Especially this one - it is really scary.
+
+## Attribution
+
+Creating re-usable tools from scripts: The Galaxy Tool Factory
+Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team
+Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573
+
+http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573?ijkey=lczQh1sWrMwdYWJ&keytype=ref
+
diff -r 312eb2aaf313 -r 7596aa302d60 toolfactory/ToolFactory.py
--- a/toolfactory/ToolFactory.py Mon Jun 21 04:18:59 2021 +0000
+++ b/toolfactory/ToolFactory.py Thu Jul 01 05:52:07 2021 +0000
@@ -851,7 +851,7 @@
a("--bad_user", default=None)
a("--help_text", default=None)
a("--tool_desc", default=None)
- a("--tool_version", default=None)
+ a("--tool_version", default="0.01")
a("--citations", default=None)
a("--command_override", default=None)
a("--test_override", default=None)
diff -r 312eb2aaf313 -r 7596aa302d60 toolfactory/ToolFactory.xml
--- a/toolfactory/ToolFactory.xml Mon Jun 21 04:18:59 2021 +0000
+++ b/toolfactory/ToolFactory.xml Thu Jul 01 05:52:07 2021 +0000
@@ -143,12 +143,8 @@
-
-
-
-
-
+
+
@@ -363,7 +359,6 @@
-
@@ -412,7 +407,7 @@
-
+ rm
diff -r 312eb2aaf313 -r 7596aa302d60 toolfactory/ToolFactoryDemosApril30.ga
--- a/toolfactory/ToolFactoryDemosApril30.ga Mon Jun 21 04:18:59 2021 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,965 +0,0 @@
-{
- "a_galaxy_workflow": "true",
- "annotation": "",
- "format-version": "0.1",
- "name": "ToolFactory - make, test and install demonstration tools",
- "steps": {
- "0": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 0,
- "input_connections": {},
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": -152.39999389648438,
- "height": 102.60000610351562,
- "left": 252.5,
- "right": 452.5,
- "top": -255,
- "width": 200,
- "x": 252.5,
- "y": -255
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"__workflow_invocation_uuid__\": \"dbb99db2a98811ebbc9e0242ac1b0004\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_prefix\": \"\", \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"bash\", \"dynScript\": \"echo \\\"Hello $1\\\"\"}}, \"help_text\": \"**What it Does**\", \"install\": \"false\", \"io_param\": {\"ppass\": {\"parampass\": \"positional\", \"__current_case__\": 1, \"io\": {\"history_inputs\": [], \"history_outputs\": [{\"__index__\": 0, \"history_name\": \"Hello_output\", \"history_format\": \"txt\", \"history_CL\": \"STDOUT\", \"history_test\": \"diff:0\"}], \"collection_outputs\": []}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": [{\"__index__\": 0, \"param_name\": \"say_hello_to\", \"ap_type\": {\"param_type\": \"text\", \"__current_case__\": 0, \"param_value\": \"\"}, \"param_label\": \"Say hello to\", \"param_help\": \"\", \"param_CL\": \"1\", \"param_CLprefixed\": \"\", \"param_repeat\": \"false\"}]}}}, \"make\": {\"makeMode\": {\"__current_case__\": 1, \"citations\": [], \"galaxy_apikey\": \"fakekey\", \"galaxy_url\": \"http://localhost:8080\", \"help_text\": \"**What it Does**\\nToolFactory demonstration - hello world in Galaxy\", \"make_Tool\": \"gentest\", \"tool_desc\": \"Says hello\", \"tool_version\": \"0.01\", \"toolshed_apikey\": \"fakekey\", \"toolshed_url\": \"http://localhost:9009\"}}, \"run_test\": \"true\", \"tool_desc\": \"\", \"tool_name\": \"hello_toolshed\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "f07cf7c8-4a96-4c4f-bd7b-d43c30642369",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "5e1e49e0-ed56-4c7a-95fe-2f66aa4d7165"
- }
- ]
- },
- "1": {
- "annotation": "",
- "content_id": null,
- "errors": null,
- "id": 1,
- "input_connections": {},
- "inputs": [
- {
- "description": "",
- "name": "bwa-mem-fastq1.fq"
- }
- ],
- "label": "bwa-mem-fastq1.fq",
- "name": "Input dataset",
- "outputs": [],
- "position": {
- "bottom": 353.1999969482422,
- "height": 82.19999694824219,
- "left": 252.5,
- "right": 452.5,
- "top": 271,
- "width": 200,
- "x": 252.5,
- "y": 271
- },
- "tool_id": null,
- "tool_state": "{\"optional\": false}",
- "tool_version": null,
- "type": "data_input",
- "uuid": "e1c43d57-ee0e-42ea-aed7-d86c595d06e7",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "output",
- "uuid": "ecd799ad-b7be-4b58-87ea-050884620d99"
- }
- ]
- },
- "2": {
- "annotation": "",
- "content_id": null,
- "errors": null,
- "id": 2,
- "input_connections": {},
- "inputs": [
- {
- "description": "",
- "name": "bwa-mem-mt-genome.fa"
- }
- ],
- "label": "bwa-mem-mt-genome.fa",
- "name": "Input dataset",
- "outputs": [],
- "position": {
- "bottom": 473.1999969482422,
- "height": 82.19999694824219,
- "left": 252.5,
- "right": 452.5,
- "top": 391,
- "width": 200,
- "x": 252.5,
- "y": 391
- },
- "tool_id": null,
- "tool_state": "{\"optional\": false}",
- "tool_version": null,
- "type": "data_input",
- "uuid": "98ae8bb5-cd5c-4330-b0cc-4d2252b0eee1",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "output",
- "uuid": "c0b94cf6-886f-4260-9e63-a2e57435a628"
- }
- ]
- },
- "3": {
- "annotation": "",
- "content_id": null,
- "errors": null,
- "id": 3,
- "input_connections": {},
- "inputs": [
- {
- "description": "",
- "name": "hello_toolshed_toolshed.gz"
- }
- ],
- "label": "hello_toolshed_toolshed.gz",
- "name": "Input dataset",
- "outputs": [],
- "position": {
- "bottom": -333.8000030517578,
- "height": 82.19999694824219,
- "left": 252.5,
- "right": 452.5,
- "top": -416,
- "width": 200,
- "x": 252.5,
- "y": -416
- },
- "tool_id": null,
- "tool_state": "{\"optional\": false}",
- "tool_version": null,
- "type": "data_input",
- "uuid": "f65affe8-b8b2-4e54-9e1a-57f038e31d04",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "output",
- "uuid": "68da073d-aa54-470c-aab5-a429846870eb"
- }
- ]
- },
- "4": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 4,
- "input_connections": {},
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": -313.3999938964844,
- "height": 102.60000610351562,
- "left": 530.5,
- "right": 730.5,
- "top": -416,
- "width": 200,
- "x": 530.5,
- "y": -416
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"swi-prolog\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"swipl -q -g main -s \", \"dynScript\": \"parent(pam,bob).\\nparent(tom,bob).\\nparent(tom,liz).\\nparent(bob,ann).\\nparent(bob,pat).\\nparent(pat,jim).\\n\\nmain :-\\n parent(X,jim),\\n format('~a is the parent of jim~n', [X]),\\n halt.\"}}, \"help_text\": \"**What it Does**\", \"install\": \"true\", \"io_param\": {\"ppass\": {\"parampass\": \"positional\", \"__current_case__\": 1, \"io\": {\"history_inputs\": [], \"history_outputs\": [{\"__index__\": 0, \"history_name\": \"prolog_out\", \"history_format\": \"txt\", \"history_CL\": \"STDOUT\", \"history_test\": \"diff:0\"}], \"collection_outputs\": []}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": []}}}, \"run_test\": \"true\", \"tool_desc\": \"\", \"tool_name\": \"prolog_demo\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "b912fc6c-2ac9-4b29-8b29-abb960e75468",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "4d4d0421-9ae5-4b3a-8c81-ccfbe02cbada"
- }
- ]
- },
- "5": {
- "annotation": "",
- "content_id": null,
- "errors": null,
- "id": 5,
- "input_connections": {},
- "inputs": [
- {
- "description": "",
- "name": "phiX.fasta"
- }
- ],
- "label": "phiX.fasta",
- "name": "Input dataset",
- "outputs": [],
- "position": {
- "bottom": -176.1999969482422,
- "height": 61.80000305175781,
- "left": 808.5,
- "right": 1008.5,
- "top": -238,
- "width": 200,
- "x": 808.5,
- "y": -238
- },
- "tool_id": null,
- "tool_state": "{\"optional\": false}",
- "tool_version": null,
- "type": "data_input",
- "uuid": "0e9d6723-9165-413d-95e0-cb7cad549c86",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "output",
- "uuid": "cd0767ab-f0f3-47c1-8eb0-ac40700c3a5e"
- }
- ]
- },
- "6": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 6,
- "input_connections": {},
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": -313.3999938964844,
- "height": 102.60000610351562,
- "left": 808.5,
- "right": 1008.5,
- "top": -416,
- "width": 200,
- "x": 808.5,
- "y": -416
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"bash\", \"dynScript\": \"echo \\\"Hello $1\\\"\"}}, \"help_text\": \"**What it Does**\\nPrototype bash script with a text input and a new history output.\\nRemarkably useful as a starting point - add a new bash script and add the appropriate parameters to make a new tool.\", \"install\": \"true\", \"io_param\": {\"ppass\": {\"parampass\": \"positional\", \"__current_case__\": 1, \"io\": {\"history_inputs\": [], \"history_outputs\": [{\"__index__\": 0, \"history_name\": \"Hello_output\", \"history_format\": \"txt\", \"history_CL\": \"STDOUT\", \"history_test\": \"diff:0\"}], \"collection_outputs\": []}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": [{\"__index__\": 0, \"param_name\": \"say_hello_to\", \"ap_type\": {\"param_type\": \"text\", \"__current_case__\": 0, \"param_value\": \"Hello from the ToolFactory!\"}, \"param_label\": \"Say hello to\", \"param_help\": \"\", \"param_CL\": \"1\", \"param_CLprefixed\": \"\", \"param_repeat\": \"false\"}]}}}, \"run_test\": \"true\", \"tool_desc\": \"ToolFactory demonstration using a bash script.\", \"tool_name\": \"hello_toolshed\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "877a5d8c-e46f-48b0-9c54-5bbf302c8719",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "56928b22-2cb6-4b3a-ab79-987d3cdbbba2"
- }
- ]
- },
- "7": {
- "annotation": "",
- "content_id": null,
- "errors": null,
- "id": 7,
- "input_connections": {},
- "inputs": [
- {
- "description": "",
- "name": "rgToolFactory2.py"
- }
- ],
- "label": "rgToolFactory2.py",
- "name": "Input dataset",
- "outputs": [],
- "position": {
- "bottom": 562.1999969482422,
- "height": 82.19999694824219,
- "left": 818.5,
- "right": 1018.5,
- "top": 480,
- "width": 200,
- "x": 818.5,
- "y": 480
- },
- "tool_id": null,
- "tool_state": "{\"optional\": false}",
- "tool_version": null,
- "type": "data_input",
- "uuid": "60049d1f-78bd-4a84-bad4-23263ea7d023",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "output",
- "uuid": "3d75794b-a995-4f36-b622-71fd91edd084"
- }
- ]
- },
- "8": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 8,
- "input_connections": {},
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": -313.3999938964844,
- "height": 102.60000610351562,
- "left": 1086.5,
- "right": 1286.5,
- "top": -416,
- "width": 200,
- "x": 1086.5,
- "y": -416
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"bash\", \"dynScript\": \"echo \\\"You chose $1\\\"\"}}, \"help_text\": \"**What it Does**\\nDemonstrates select parameters generated by ToolFactory forms\", \"install\": \"true\", \"io_param\": {\"ppass\": {\"parampass\": \"positional\", \"__current_case__\": 1, \"io\": {\"history_inputs\": [], \"history_outputs\": [{\"__index__\": 0, \"history_name\": \"select_out\", \"history_format\": \"txt\", \"history_CL\": \"STDOUT\", \"history_test\": \"diff:0\"}], \"collection_outputs\": []}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": [{\"__index__\": 0, \"param_name\": \"choose\", \"ap_type\": {\"param_type\": \"selecttext\", \"__current_case__\": 4, \"selectTexts\": [{\"__index__\": 0, \"select_text\": \"one\", \"select_value\": \"won\"}, {\"__index__\": 1, \"select_text\": \"two\", \"select_value\": \"too\"}, {\"__index__\": 2, \"select_text\": \"three\", \"select_value\": \"free\"}]}, \"param_label\": \"Choose\", \"param_help\": \"\", \"param_CL\": \"1\", \"param_CLprefixed\": \"\", \"param_repeat\": \"false\"}]}}}, \"run_test\": \"true\", \"tool_desc\": \"ToolFactory select demonstration\", \"tool_name\": \"select_test\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "f9c9d681-b626-426c-b8fb-19503ea4571e",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "3de506bf-9ad1-4d1f-be29-e42ae6f37a34"
- }
- ]
- },
- "9": {
- "annotation": "",
- "content_id": null,
- "errors": null,
- "id": 9,
- "input_connections": {},
- "inputs": [
- {
- "description": "",
- "name": "hello_lisp.txt"
- }
- ],
- "label": "hello_lisp.txt",
- "name": "Input dataset",
- "outputs": [],
- "position": {
- "bottom": -4.1999969482421875,
- "height": 61.80000305175781,
- "left": 1364.5,
- "right": 1564.5,
- "top": -66,
- "width": 200,
- "x": 1364.5,
- "y": -66
- },
- "tool_id": null,
- "tool_state": "{\"optional\": false}",
- "tool_version": null,
- "type": "data_input",
- "uuid": "4883c5d1-15ec-4595-8488-9c5ce453d632",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "output",
- "uuid": "9af42c99-a5bf-4835-8408-767d7273ceb0"
- }
- ]
- },
- "10": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 10,
- "input_connections": {},
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": -313.3999938964844,
- "height": 102.60000610351562,
- "left": 1364.5,
- "right": 1564.5,
- "top": -416,
- "width": 200,
- "x": 1364.5,
- "y": -416
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"r-base\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"Rscript\", \"dynScript\": \"# demo\\nargs = commandArgs(trailingOnly=TRUE)\\nif (length(args)==0) {\\n n_plots = 3 \\n} else {\\n n_plots = as.integer(args[1]) }\\ndir.create('plots')\\nfor (i in 1:n_plots) {\\n foo = runif(100)\\n bar = rnorm(100)\\n bar = foo + 0.05*bar\\n pdf(paste('plots/yet',i,\\\"anotherplot.pdf\\\",sep='_'))\\n plot(foo,bar,main=paste(\\\"Foo by Bar plot #\\\",i),col=\\\"maroon\\\", pch=3,cex=0.6)\\n dev.off()\\n foo = data.frame(a=runif(100),b=runif(100),c=runif(100),d=runif(100),e=runif(100),f=runif(100))\\n bar = as.matrix(foo)\\n pdf(paste('plots/yet',i,\\\"anotherheatmap.pdf\\\",sep='_'))\\n heatmap(bar,main='Random Heatmap')\\n dev.off()\\n}\\n\"}}, \"help_text\": \"**What it Does**\\nToolFactory demonstration of a collection to hide lots of outputs from a tool in a single history item to avoid clutter.\\nAs many random plots as you want.\\nViewable inside the resulting history collection\\nScript is responsible for writing all the appropriate outputs into a directory called the same name as the collection as shown here.\\nVery handy for things not useful downstream but useful for the user to review and study.\", \"install\": \"true\", \"io_param\": {\"ppass\": {\"parampass\": \"positional\", \"__current_case__\": 1, \"io\": {\"history_inputs\": [], \"history_outputs\": [], \"collection_outputs\": [{\"__index__\": 0, \"name\": \"plots\", \"kind\": \"list\", \"label\": \"Plots\", \"discover\": \"__name_and_ext__\"}]}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": [{\"__index__\": 0, \"param_name\": \"nplot\", \"ap_type\": {\"param_type\": \"text\", \"__current_case__\": 0, \"param_value\": \"3\"}, \"param_label\": \"Number of random plots pairs to draw\", \"param_help\": \"\", \"param_CL\": \"1\", \"param_CLprefixed\": \"\", \"param_repeat\": \"false\"}]}}}, \"run_test\": \"true\", \"tool_desc\": \"Collection demonstration\", \"tool_name\": \"plotter\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "d00bd283-f69e-4537-9ccc-a5fa753e9f53",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "4d769d8b-370c-444e-9245-2b2fa719ca99"
- }
- ]
- },
- "11": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 11,
- "input_connections": {},
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": -293,
- "height": 123,
- "left": 1642.5,
- "right": 1842.5,
- "top": -416,
- "width": 200,
- "x": 1642.5,
- "y": -416
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"bash\", \"dynScript\": \"# pathetic attempt at a malicious script in Galaxy\\n# it fails because the job execution environment gives write access to few places\\necho \\\"ls -la\\\"\\nls -la\\ncd /\\necho \\\"ls -la after changing to /\\\"\\nls -la\\ntouch \\\"foo_was.here\\\"\\necho \\\"ls -la in root after touch foo_was.here - foo_was_not.here more like it\\\"\\nls -la\\n\"}}, \"help_text\": \"**What it Does**\\nShows what you can't do with a bash script\\nCheck the tool stderr - it isn't captured but should be. Send code.\\nResults vary - in a biocontainer, you are root so can do anything.\\nIn a normal Galaxy, not so much.\\nThis is a very interesting way to see what a tool can do on your machine.\", \"install\": \"true\", \"io_param\": {\"ppass\": {\"parampass\": \"positional\", \"__current_case__\": 1, \"io\": {\"history_inputs\": [], \"history_outputs\": [{\"__index__\": 0, \"history_name\": \"evil_script_output\", \"history_format\": \"txt\", \"history_CL\": \"STDOUT\", \"history_test\": \"sim_size:0.05\"}], \"collection_outputs\": []}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": []}}}, \"run_test\": \"true\", \"tool_desc\": \"Tries some naughty things\", \"tool_name\": \"evil_script_that_fails\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "4c24a895-4cf6-43ec-8517-769974115809",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "d19ecbb5-e61e-46f1-a37b-2b54e0eaba1b"
- }
- ]
- },
- "12": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 12,
- "input_connections": {
- "io_param|ppass|io|history_inputs_0|input_files": {
- "id": 0,
- "output_name": "new_tool"
- }
- },
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": -96.60000610351562,
- "height": 154.39999389648438,
- "left": 530.5,
- "right": 730.5,
- "top": -251,
- "width": 200,
- "x": 530.5,
- "y": -251
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"planemo=0.74.1\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"bash\", \"dynScript\": \"cp $1 foo.tar \\ntar -xvf foo.tar\\nTOOLNAME=`find . -name \\\"*.xml\\\"`\\necho \\\"$$$$$TOOLNAME = $TOOLNAME\\\" > $2\\nplanemo lint $TOOLNAME >> $2\"}}, \"help_text\": \"**What it Does**\\nToolFactory demonstration script using bash to run planemo lint from a history tarball\", \"install\": \"true\", \"io_param\": {\"ppass\": {\"parampass\": \"positional\", \"__current_case__\": 1, \"io\": {\"history_inputs\": [{\"__index__\": 0, \"input_files\": {\"__class__\": \"ConnectedValue\"}, \"input_formats\": [\"tgz\", \"toolshed.gz\"], \"input_label\": \"Toolshed archive to be linted\", \"input_help\": \"\", \"input_CL\": \"1\", \"input_repeat\": \"false\"}], \"history_outputs\": [{\"__index__\": 0, \"history_name\": \"lint_output\", \"history_format\": \"txt\", \"history_CL\": \"2\", \"history_test\": \"diff:5\"}], \"collection_outputs\": []}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": []}}}, \"run_test\": \"true\", \"tool_desc\": \"Runs Planemo lint on any toolshed.gz file\", \"tool_name\": \"planemo_lint\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "170f36c8-8681-477e-ba9d-8e6c8965f735",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "0e7fba79-fda8-44e7-912c-324f79d2caf2"
- }
- ]
- },
- "13": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 13,
- "input_connections": {
- "io_param|ppass|io|history_inputs_0|input_files": {
- "id": 2,
- "output_name": "output"
- },
- "io_param|ppass|io|history_inputs_1|input_files": {
- "id": 1,
- "output_name": "output"
- }
- },
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": 485.6000061035156,
- "height": 225.60000610351562,
- "left": 540.5,
- "right": 740.5,
- "top": 260,
- "width": 200,
- "x": 540.5,
- "y": 260
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"yes\", \"__current_case__\": 1, \"command_override\": \"## Build reference\\n#set $reference_fasta_filename = \\\"localref.fa\\\"\\nln -s \\\"${ref_file}\\\" \\\"${reference_fasta_filename}\\\" ;\\nbwa index -a is \\\"${reference_fasta_filename}\\\" ;\\nbwa mem -t \\\"\\\\${GALAXY_SLOTS:-4}\\\" -v 1 \\\"${reference_fasta_filename}\\\" \\\"${fastq_input1}\\\" | samtools view -Sb - > temporary_bam_file.bam ;\\nsamtools sort -o \\\"${bwa_test_commover_bam_output}\\\" temporary_bam_file.bam\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"bwa=0.7.15, samtools=1.3\", \"usescript\": {\"choosescript\": \"no\", \"__current_case__\": 0, \"dynScript\": \"\", \"scriptrunner\": \"\"}}, \"help_text\": \"**What it Does**\\nTrivial example from a Planemo documentation example\\nIt can be useful. It is sort of bash with substitutions from the tool form.\\nIf you need it, it's here.\", \"install\": \"true\", \"io_param\": {\"ppass\": {\"parampass\": \"argparse\", \"__current_case__\": 0, \"io\": {\"history_inputs\": [{\"__index__\": 0, \"input_files\": {\"__class__\": \"ConnectedValue\"}, \"input_formats\": [\"fasta\"], \"input_label\": \"Reference sequence to align reads\", \"input_help\": \"\", \"input_CL\": \"ref_file\", \"input_repeat\": \"false\"}, {\"__index__\": 1, \"input_files\": {\"__class__\": \"ConnectedValue\"}, \"input_formats\": [\"fastqsanger\"], \"input_label\": \"Fastqsanger file containing reads to be mapped against reference\", \"input_help\": \"\", \"input_CL\": \"fastq_input1\", \"input_repeat\": \"false\"}], \"history_outputs\": [{\"__index__\": 0, \"history_name\": \"bwa_test_commover_bam_output\", \"history_format\": \"bam\", \"history_CL\": \"\", \"history_test\": \"sim_size:0.1\"}], \"collection_outputs\": []}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": []}}}, \"run_test\": \"true\", \"tool_desc\": \"Command over-ride demonstration\", \"tool_name\": \"bwa_test_command_override\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "43535a6f-1066-4b85-b347-f310858995a7",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "a48f2e86-7017-47b8-8c2b-e81b25cf9590"
- }
- ]
- },
- "14": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 14,
- "input_connections": {
- "io_param|ppass|io|history_inputs_0|input_files": {
- "id": 2,
- "output_name": "output"
- },
- "io_param|ppass|io|history_inputs_1|input_files": {
- "id": 1,
- "output_name": "output"
- }
- },
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": 749.6000061035156,
- "height": 225.60000610351562,
- "left": 540.5,
- "right": 740.5,
- "top": 524,
- "width": 200,
- "x": 540.5,
- "y": 524
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"bwa=0.7.15, samtools=1.3\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"bash\", \"dynScript\": \"REFFILE=$1\\nFASTQ=$2\\nBAMOUT=$3\\nrm -f \\\"refalias\\\"\\nln -s \\\"$REFFILE\\\" \\\"refalias\\\"\\nbwa index -a is \\\"refalias\\\"\\nbwa mem -t \\\"2\\\" -v 1 \\\"refalias\\\" \\\"$FASTQ\\\" > tempsam\\nsamtools view -Sb tempsam > temporary_bam_file.bam\\nsamtools sort -o \\\"$BAMOUT\\\" temporary_bam_file.bam\\n\"}}, \"help_text\": \"**What it Does**\\nSame thing as the command over-ride version but using a bash script and passing parameters.\\nProbably more familiar to many non-Galaxy developers.\", \"install\": \"true\", \"io_param\": {\"ppass\": {\"parampass\": \"positional\", \"__current_case__\": 1, \"io\": {\"history_inputs\": [{\"__index__\": 0, \"input_files\": {\"__class__\": \"ConnectedValue\"}, \"input_formats\": [\"fasta\"], \"input_label\": \"Reference sequence to map reads against\", \"input_help\": \"\", \"input_CL\": \"1\", \"input_repeat\": \"false\"}, {\"__index__\": 1, \"input_files\": {\"__class__\": \"ConnectedValue\"}, \"input_formats\": [\"fastq\"], \"input_label\": \"Reads to map\", \"input_help\": \"\", \"input_CL\": \"2\", \"input_repeat\": \"false\"}], \"history_outputs\": [{\"__index__\": 0, \"history_name\": \"bwa_test_bash_output\", \"history_format\": \"bam\", \"history_CL\": \"3\", \"history_test\": \"sim_size:0.1\"}], \"collection_outputs\": []}, \"addparam\": {\"edit_params\": \"yes\", \"additional_parameters\": []}}}, \"run_test\": \"true\", \"tool_desc\": \"Bash script equivalent of the bwa command over-ride.\", \"tool_name\": \"bwa_test_toolfactory_positional_bash\", \"tool_version\": \"0.01\", \"__page__\": null, \"__rerun_remap_job_id__\": null}",
- "tool_version": "2.00",
- "type": "tool",
- "uuid": "dc44d183-23e3-45cc-978a-336280ec70a6",
- "workflow_outputs": [
- {
- "label": null,
- "output_name": "new_tool",
- "uuid": "c7943d13-c9c1-41ec-a055-a7cb1af39b6e"
- }
- ]
- },
- "15": {
- "annotation": "",
- "content_id": "rgtf2",
- "errors": null,
- "id": 15,
- "input_connections": {
- "io_param|ppass|io|history_inputs_0|input_files": {
- "id": 5,
- "output_name": "output"
- }
- },
- "inputs": [],
- "label": null,
- "name": "toolfactory",
- "outputs": [
- {
- "name": "new_tool",
- "type": "toolshed.gz"
- }
- ],
- "position": {
- "bottom": 91.39999389648438,
- "height": 154.39999389648438,
- "left": 1086.5,
- "right": 1286.5,
- "top": -63,
- "width": 200,
- "x": 1086.5,
- "y": -63
- },
- "post_job_actions": {},
- "tool_id": "rgtf2",
- "tool_state": "{\"__input_ext\": \"input\", \"chromInfo\": \"/galaxy/tool-data/shared/ucsc/chrom/?.len\", \"citations\": [], \"cl_suffix\": \"\", \"cover\": {\"commover\": \"no\", \"__current_case__\": 0, \"command_override\": \"\", \"test_override\": \"\"}, \"deps\": {\"packages\": \"perl\", \"usescript\": {\"choosescript\": \"yes\", \"__current_case__\": 1, \"scriptrunner\": \"perl\", \"dynScript\": \"#!/usr/bin/perl -w\\n\\n# usage : perl toolExample.pl