← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to share/OpenMS/TOOLS/EXTERNAL/TEMPLATE.ttd_

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2012-11-12 15:58:12 UTC
  • Revision ID: package-import@ubuntu.com-20121112155812-vr15wtg9b50cuesg
Tags: upstream-1.9.0
Import upstream version 1.9.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
share/OpenMS/TOOLS/EXTERNAL/TEMPLATE.ttd_
 
1
<ttd>
 
2
        <tool status="external">
 
3
                <category>does not really matter</category>
 
4
                // this is the name of the '-type' which is added to GenericWrapper - so chose carefully
 
5
                <type>RAWFileConvert</type>
 
6
                // description of the wrapper
 
7
                <external>
 
8
      <text>
 
9
        <onstartup>This is printed on startup ... Wrapper was tested with "external_tool" vX.Y.Z, report issues to the OpenMS team at www.OpenMS.de</onstartup>
 
10
        <onfail>This is printed in case of error - you can list possible causes for failure here...</onfail>
 
11
        <onfinish>This is printed when finished successfully.</onfinish>
 
12
      </text>    
 
13
                  // currently disregarded by TOPPAS, but might become useful
 
14
                  <e_category>FileConversion</e_category>
 
15
                  // command line options of your external tool (use placeholders ,e.g. %1 to insert dynamic content)
 
16
                  <cloptions>-o "%1" --mzML %2</cloptions>
 
17
                  // the actual executable (usually it should be in your PATH, to avoid having to specify a full path to it)
 
18
                  <path>msconvert</path>
 
19
      // sets the working directory to this path before calling the external tool. Some tools write to the current working directory
 
20
      // and thus starting the tool from somewhere else might actually lead to trouble
 
21
      // use only real paths here (no placeholders like %TMP)
 
22
      <workingdirectory>.</workingdirectory>
 
23
                  // these mappings connect input parameters (from the 'ini_param' section below) and the command line options of your tool
 
24
                  // any INI parameter can be referenced using %%'param_name', e.g. %%in
 
25
                  // additionally you can use %TMP and %BASENAME[X] to get the current temp directory to store data, or the basename of X
 
26
                  <mappings>
 
27
                        <mapping id="1" cl="%TMP" />
 
28
                        <mapping id="2" cl="%%in" />
 
29
 
 
30
                        // output mapping/copying: this is a little hard to explain and usually you will not need it (then you have to delete all file-tags!)
 
31
                        // what it does: when the wrapped tool works with in-place files (i.e. overwrites its input), you must copy it before
 
32
                        //               ,e.g. TPP's RefreshParser will overwrite its input pepXML file
 
33
                        //               The targeted parameter gets replaced with the temporary filename after the copy is done, so that subsequent
 
34
                        //               operations target the temp file
 
35
      <file_pre location="%TMP/%RND_%%in" target="in" />
 
36
      
 
37
                        // output mapping/moving: this is a little hard to explain and usually you will not need it (then you have to delete all file-tags!)
 
38
                        // what it does: when you cannot specify an explicit output file to the external tool and it rather determines that by itself
 
39
                        //               ,e.g. msconvert will create an output file (call it F_E) which has the same name as the input file with a replaced suffix
 
40
                        //               then you might need to move F_E to the name you want (and/or where TOPPAS can find it)
 
41
                        //               Thus you specify the name of F_E and the target name (in terms of INI parameter values)
 
42
                        <file_post location="%TMP/%BASENAME[%%in].mzML" target="out" />
 
43
                  </mappings>
 
44
                  <ini_param>
 
45
                        <ITEM name="in" value="" type="string" description="input file in RAW format(valid formats: &apos;RAW&apos;)" tags="input file" />
 
46
                        <ITEM name="out" value="" type="string" description="output file in mzML format(valid formats: &apos;mzML&apos;)" tags="output file" />
 
47
                  </ini_param>
 
48
                </external>
 
49
        </tool>
 
50
</ttd>
 
 
b'\\ No newline at end of file'