“Defaults”

This is a poorly named parameter and a result of legacy code. It may eventually be renamed.

It consists of a dict with four parameters:

  • appid: I tend to use Java style class names to ensure my app IDs don’t conflict with any other scripts’. This is a legacy of tools not from the toolshed which shared a global tool ID namespace. Now, toolshed tools are prefixed with the repo URL which is unique.
  • appname: the tool’s name. Present in command line help and as the tool name in galaxy
  • appdesc: short, one sentence description of what it does.
  • appvers: pick a versioning scheme and stick to it.
defaults={
    'appid': 'ggo.tests.GenericScript',
    'appname': 'GGO Test Script',
    'appdesc': 'tests use of the script',
    'appvers': '1.0.0',
}

Previous topic

Creating Parameters

Next topic

Documenting Tools

This Page