[ARVADOS] updated: a2eb617fd123c6123a5defe9a904a8a0542e236c

git at public.curoverse.com git at public.curoverse.com
Thu Jul 31 12:44:37 EDT 2014


Summary of changes:
 doc/user/tutorials/tutorial-firstscript.html.textile.liquid | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

       via  a2eb617fd123c6123a5defe9a904a8a0542e236c (commit)
       via  033c9aee7dceec10418f6b220358f45002bef770 (commit)
      from  698f00b7f1c760f504963b42720c7fa2cbc66e48 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit a2eb617fd123c6123a5defe9a904a8a0542e236c
Author: radhika <radhika at curoverse.com>
Date:   Thu Jul 31 12:27:02 2014 -0400

    3016: add detais about search_for in the firstscript tutorial

diff --git a/doc/user/tutorials/tutorial-firstscript.html.textile.liquid b/doc/user/tutorials/tutorial-firstscript.html.textile.liquid
index 476fdf2..521582b 100644
--- a/doc/user/tutorials/tutorial-firstscript.html.textile.liquid
+++ b/doc/user/tutorials/tutorial-firstscript.html.textile.liquid
@@ -108,7 +108,8 @@ Next, create a file that contains the pipeline definition:
       "script_parameters":{
         "input":{
           "required": true,
-          "dataclass": "Collection"
+          "dataclass": "Collection",
+          "search_for": ".fastq.gz"
         }
       },
       "repository":"$USER",
@@ -130,7 +131,7 @@ EOF
 * @"repository"@ is the name of a git repository to search for the script version.  You can access a list of available git repositories on the Arvados Workbench under "Code repositories":https://{{site.arvados_workbench_host}}/repositories.  Your shell should automatically fill in @$USER@ with your login name, so that the final JSON has @"repository"@ pointed at your personal Git repository.
 * @"script_version"@ specifies the version of the script that you wish to run.  This can be in the form of an explicit Git revision hash, a tag, or a branch (in which case it will use the HEAD of the specified branch).  Arvados logs the script version that was used in the run, enabling you to go back and re-run any past job with the guarantee that the exact same code will be used as was used in the previous run.
 * @"script"@ specifies the filename of the script to run.  Crunch expects to find this in the @crunch_scripts/@ subdirectory of the Git repository.
-* @"script_parameters"@ describes the parameters for the script.  In this example, there is one parameter called @input@ which is @required@ and is a @Collection at .
+* @"script_parameters"@ describes the parameters for the script. In this example, there is one parameter called @input@ which is @required@ and is a @Collection at . You can also specify a @search_for@ string for this @input@ parameter. When configured, the @search_for@ string will be preloaded into the input data chooser dialog in Workbench when choosing inputs for this @input@ parameter. The @search_for@ string is meaningful only when input @dataclass@ of type @Collection@ or @File@ is used. In this example @.fastq.gz@ is used as the @search_for@ string. This can come handy if you know what types of input you will be searching for when running this pipeline. For example, if your input @dataclass@ is a @File@ and you are interested in a certain filename extention, you can preconfigure it as the @search_for@ string.
 * @"output_is_persistent"@ indicates whether the output of the job is considered valuable. If this value is false (or not given), the output will be treated as intermediate data and eventually deleted to reclaim disk space.
 
 Now, use @arv pipeline_template create@ to register your pipeline template in Arvados:

-----------------------------------------------------------------------


hooks/post-receive
-- 




More information about the arvados-commits mailing list