Mercurial > repos > galaxyp > openms_mztabexporter
diff readme.md @ 1:495fd95b26e2 draft
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 9a14ed1f2d3c9abdfb080251b3419dd9e0c52a14
author | galaxyp |
---|---|
date | Wed, 09 Aug 2017 09:47:32 -0400 |
parents | bf32e0bcf554 |
children | 3a9fa139c433 |
line wrap: on
line diff
--- a/readme.md Wed Mar 01 12:50:44 2017 -0500 +++ b/readme.md Wed Aug 09 09:47:32 2017 -0400 @@ -14,15 +14,29 @@ Generating OpenMS wrappers ========================== - * install OpenMS (you can do this automatically through the Tool Shed) + * install OpenMS (you can do this automatically through Conda) * create a folder called CTD - * inside of your new installed openms/bin folder, execute the following command: + * if you installed openms as a binary in a specific directory, execute the following command in the `openms/bin` directory: ```bash for binary in `ls`; do ./$binary -write_ctd /PATH/TO/YOUR/CTD; done; ``` - * `MetaProSIP.ctd` includes a not supported character: To use it, search for `²` and replace it (e.g. with `^2`). + * if there is no binary release (e.g. as with version 2.2), download and unpack the Conda package, find the `bin` folder and create a list of the tools as follow: + + ```bash + ls >> tools.txt + ``` + + * search for the `bin` folder of your conda environment containing OpenMS and do: + + ```bash + while read p; do + ./PATH/TO/BIN/$p -write_ctd /PATH/TO/YOUR/CTD; + done <tools.txt + ``` + + * You should have all CTD files now. `MetaProSIP.ctd` includes a not supported character: To use it, search for `²` and replace it (e.g. with `^2`). * clone or install CTDopts @@ -39,10 +53,10 @@ * clone or install CTD2Galaxy ```bash - git clone https://github.com/blankclemens/CTD2Galaxy.git + git clone https://github.com/WorkflowConversion/CTD2Galaxy.git ``` - * If you have CTDopts and CTD2Galaxy installed you are ready to generate Galaxy Tools from CTD definitions. Change the following command according to your needs, especially the `/PATH/TO` parts. + * If you have CTDopts and CTD2Galaxy installed you are ready to generate Galaxy Tools from CTD definitions. Change the following command according to your needs, especially the `/PATH/TO` parts. The default files are provided in this repository. You might have to install `libxslt` and `lxml` to run it. ```bash python generator.py \ @@ -102,17 +116,32 @@ [...] ]]> ``` - * In `PeakPickerHiRes.xml`, the parameter `report_FWHM_unit` has to be put in quotation marks. Look for the following line + + * In `IDFileConverter.xml` the following is needed in the command section at the beginning (check your file to know what to copy where): - -algorithm:report_FWHM_unit $param_algorithm_report_FWHM_unit - - and change it to + ``` + <command><![CDATA[ - -algorithm:report_FWHM_unit "$param_algorithm_report_FWHM_unit" + ## check input file type + #set $in_type = $param_in.ext + + ## create the symlinks to set the proper file extension, since IDFileConverter uses them to choose how to handle the input files + ln -s '$param_in' 'param_in.${in_type}' && + + IDFileConverter - * In `FileConverter.xml` add `auto_format="true"` to the output, e.g.: + #if $param_in: + -in 'param_in.${in_type}' + #end if + + [...] + ]]> + ``` + + * In `IDFileConverter.xml` and `FileConverter.xml` add `auto_format="true"` to the output, e.g.: - <data name="param_out" metadata_source="param_in" auto_format="true"/> + - `<data name="param_out" auto_format="true"/>` + - `<data name="param_out" metadata_source="param_in" auto_format="true"/>` * To add an example test case to `DecoyDatabase.xml` add the following after the output section. If standard settings change you might have to adjust the options and/or the test files.