{"_id":"5640bb0ceaede117005c99d8","parentDoc":null,"project":"55faf11ba62ba1170021a9a7","user":"554340dfb7f4540d00fcef1d","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5637e8b2fbe1c50d008cb078","pages":["5637e95797666c0d008656ba","5637ea64ee0ee60d0024ec0e","5637f110daf0840d0011dcd5","563d423e9799fb0d0004779b","5640ba77b9c4dd0d0097c827","5640bad42b14f70d0039b8cd","5640bae32b14f70d0039b8cf","5640bb0ceaede117005c99d8","565f6b770dc99e1900f24c73","56cc9eab8fa8b01b00b81f5a","56ddcb9ab4ac273200457c82"],"__v":11,"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-02T22:50:26.865Z","from_sync":false,"order":16,"slug":"describe-your-tool","title":"DESCRIBE YOUR TOOL"},"__v":7,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-09T15:26:04.004Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"You will have noticed that when you enter an input port for a certain kind of input, a variable name for that input is added to the command line, at the bottom of the screen. For instance, if you add an input port for strings, with prefix -s, then -s <input_port_name>-string-value is added to the command line at the bottom of the editor, where <input_port_name> is the **ID** you gave to the port. This string is a dummy value; it acts a variable name for any string that you would actually enter when you run the tool. The example is shown below.\n\nSimilarly, if you add an input port for files that takes the prefix -f before the filename on the command line, then -f /path/to/<input_port_name> is added to the command line at the bottom of the editor, where, again, <input_port_name> is the ID you gave to that port. This is a dummy file path, which would be replaced with an actual one when you run the tool.\n\nIf you want to verify that the **resulting command line **shown is correct, you can assign actual values to these dummy input variables. You do this on the **Test **tab.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/l7ZLJxsHRlSnmOtmYJ4n_Screen%20Shot%202016-02-09%20at%2012.30.38.png\",\n        \"Screen Shot 2016-02-09 at 12.30.38.png\",\n        \"3310\",\n        \"1572\",\n        \"#2498e3\",\n        \"\"\n      ],\n      \"border\": true,\n      \"caption\": \"Test the Tool Description\"\n    }\n  ]\n}\n[/block]\nOn the **Test **tab you can enter values for each** Input **and for the tool's **Allocated Resources**. This allows you to inspect the **resulting command line** below to confirm that it is correct, without actually executing the tool on the input values set.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/SdVcvLPgSfeUeziwDu5O_Screen%20Shot%202016-02-09%20at%2012.40.58.png\",\n        \"Screen Shot 2016-02-09 at 12.40.58.png\",\n        \"3302\",\n        \"1574\",\n        \"#0484d9\",\n        \"\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\nIn the example below, we have set pattern as the string input value, and book.txt as the file input value:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ObxI0xaGQKKicSz61nZP_Screen%20Shot%202016-02-09%20at%2012.44.33.png\",\n        \"Screen Shot 2016-02-09 at 12.44.33.png\",\n        \"3306\",\n        \"1582\",\n        \"\",\n        \"\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"The **Test** tab also allows you to simulate the **CPU** and **Memory **values for the tool's **Allocated Resources**.  This feature is useful in the case that these resources will affect the command executed — for example, if you have set the value of one of the command line bindings to be a dynamic expression that depends on the resources allocated to the tool at runtime. For information on how allocated resources may be used in the tool description, see the section on Allocated Resources in [Advanced Features](doc:advanced-features-of-the-tool-editor).\"\n}\n[/block]\ngen","excerpt":"","slug":"test-the-tool-description","type":"basic","title":"Test the Tool Description"}

Test the Tool Description


You will have noticed that when you enter an input port for a certain kind of input, a variable name for that input is added to the command line, at the bottom of the screen. For instance, if you add an input port for strings, with prefix -s, then -s <input_port_name>-string-value is added to the command line at the bottom of the editor, where <input_port_name> is the **ID** you gave to the port. This string is a dummy value; it acts a variable name for any string that you would actually enter when you run the tool. The example is shown below. Similarly, if you add an input port for files that takes the prefix -f before the filename on the command line, then -f /path/to/<input_port_name> is added to the command line at the bottom of the editor, where, again, <input_port_name> is the ID you gave to that port. This is a dummy file path, which would be replaced with an actual one when you run the tool. If you want to verify that the **resulting command line **shown is correct, you can assign actual values to these dummy input variables. You do this on the **Test **tab. [block:image] { "images": [ { "image": [ "https://files.readme.io/l7ZLJxsHRlSnmOtmYJ4n_Screen%20Shot%202016-02-09%20at%2012.30.38.png", "Screen Shot 2016-02-09 at 12.30.38.png", "3310", "1572", "#2498e3", "" ], "border": true, "caption": "Test the Tool Description" } ] } [/block] On the **Test **tab you can enter values for each** Input **and for the tool's **Allocated Resources**. This allows you to inspect the **resulting command line** below to confirm that it is correct, without actually executing the tool on the input values set. [block:image] { "images": [ { "image": [ "https://files.readme.io/SdVcvLPgSfeUeziwDu5O_Screen%20Shot%202016-02-09%20at%2012.40.58.png", "Screen Shot 2016-02-09 at 12.40.58.png", "3302", "1574", "#0484d9", "" ], "border": true } ] } [/block] In the example below, we have set pattern as the string input value, and book.txt as the file input value: [block:image] { "images": [ { "image": [ "https://files.readme.io/ObxI0xaGQKKicSz61nZP_Screen%20Shot%202016-02-09%20at%2012.44.33.png", "Screen Shot 2016-02-09 at 12.44.33.png", "3306", "1582", "", "" ], "border": true } ] } [/block] [block:callout] { "type": "success", "body": "The **Test** tab also allows you to simulate the **CPU** and **Memory **values for the tool's **Allocated Resources**. This feature is useful in the case that these resources will affect the command executed — for example, if you have set the value of one of the command line bindings to be a dynamic expression that depends on the resources allocated to the tool at runtime. For information on how allocated resources may be used in the tool description, see the section on Allocated Resources in [Advanced Features](doc:advanced-features-of-the-tool-editor)." } [/block] gen