annotate mol2fps.xml @ 11:92c7cdc243e8 draft

"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/chemicaltoolbox/chemfp commit 70d32dc05d264ffbe03b0c62e54acd5e904c9b7e-dirty"

<tool id="ctb_chemfp_mol2fps" name="Molecule to fingerprint" version="1.6">
    <description>conversion to several different fingerprint formats</description>
    <!--parallelism method="multi" split_inputs="infile" split_mode="to_size" split_size="10000" merge_outputs="outfile"></parallelism-->
    <requirements>
        <requirement type="package" version="1.6">chemfp</requirement>
    </requirements>
    <command>
<![CDATA[

        #if $fp_opts.fp_opts_selector in ['--FP2', '--FP3', '--FP4', '--MACCS']:
            ## Open Babel fingerprints
            ob2fps $fp_opts.fp_opts_selector --in '${infile.ext}' '${infile}' -o '${outfile}' --out 'fps'
        #else:
            ## RDKit fingerprints
            rdkit2fps --in '${infile.ext}' '${infile}' -o '${outfile}' --out 'fps'
            #if $fp_opts.fp_opts_selector == "--RDK":
                --RDK
                --fpSize $fp_opts.fpSize
                --minPath $fp_opts.minPath
                --maxPath $fp_opts.maxPath
                --nBitsPerHash $fp_opts.nBitsPerHash
                $fp_opts.useHs
            #elif $fp_opts.fp_opts_selector == "--torsions":
                --torsions
                --fpSize $fp_opts.fpSize
                --targetSize $fp_opts.targetSize
            #elif $fp_opts.fp_opts_selector == "--morgan":
                --morgan
                --fpSize $fp_opts.fpSize
                --radius $fp_opts.radius
                $fp_opts.useFeatures
                $fp_opts.useChirality
                $fp_opts.useBondTypes
            #elif $fp_opts.fp_opts_selector == "--pairs":
                --pairs
                --fpSize $fp_opts.fpSize
                --minLength $fp_opts.minLength
                --maxLength $fp_opts.maxLength
            #elif $fp_opts.fp_opts_selector == "--maccs166":
                --maccs166
            #elif $fp_opts.fp_opts_selector == "--substruct":
                --substruct
            #end if
        #end if
        --errors report 2>&1
]]>
    </command>
    <inputs>
        <param name="infile" type='data' format="sdf,smi,mol,mol2,cml,inchi" label="Molecule file"/>
        <conditional name="fp_opts">
            <param name="fp_opts_selector" type="select" label="Type of fingerprint">
                <option value='--FP2' selected="True">Open Babel FP2 fingerprints</option>
                <option value='--FP3'>Open Babel FP3 fingerprints</option>
                <option value='--FP4'>Open Babel FP4 fingerprints</option>
                <option value='--MACCS'>Open Babel MACCS fingerprints</option>
                <option value='--RDK'>RDKit topological fingerprint</option>
                <option value='--torsions'>RDKit topological Torsion fingerprints</option>
                <option value='--morgan'>RDKit Morgan fingerprints</option>
                <option value='--pairs'>RDKit Atom Pair fingerprints</option>
                <option value='--maccs166'>RDKit MACCS fingerprints</option>
                <option value='--substruct'>RDKit substructure fingerprints</option>
            </param>
            <when value="--FP2" />
            <when value="--FP3" />
            <when value="--FP4" />
            <when value="--MACCS" />
            <when value="--RDK">
                <param name="fpSize" type="integer" value="2048" label="Number of bits in the fingerprint" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="minPath" type="integer" value="1" label="Minimum number of bonds to include in the subgraph" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="maxPath" type="integer" value="7" label="Maximum number of bonds to include in the subgraph" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="nBitsPerHash" type="integer" value="4" label="Number of bits to set per path" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="useHs" type="boolean" truevalue="--useHs 1" falsevalue="--useHs 0" checked="true" 
                    label="Include information about the number of hydrogens on each atom" />
            </when>
            <when value="--torsions">
                <param name="fpSize" type="integer" value="2048" label="Number of bits in the fingerprint" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="targetSize" type="integer" value="4" label="Number of target bits in the fingerprint" help="">
                    <validator type="in_range" min="1" />
                </param>
            </when>
            <when value="--morgan">
                <param name="fpSize" type="integer" value="2048" label="Number of bits in the fingerprint" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="radius" type="integer" value="2" label="Radius for the Morgan algorithm" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="useFeatures" type="boolean" truevalue="--useFeatures 1" falsevalue="--useFeatures 0" checked="false"
                    label="Include information about the number of hydrogens on each atom" />
                <param name="useChirality" type="boolean" truevalue="--useChirality 1" falsevalue="--useChirality 0" checked="false"
                    label="Include information about the number of hydrogens on each atom" />
                <param name="useBondTypes" type="boolean" truevalue="--useBondTypes 1" falsevalue="--useBondTypes 0" checked="true"
                    label="Include information about the number of hydrogens on each atom" />
            </when>
            <when value="--pairs">
                <param name="fpSize" type="integer" value="2048" label="Number of bits in the fingerprint" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="minLength" type="integer" value="1" label="Minimum bond count for a pair" help="">
                    <validator type="in_range" min="1" />
                </param>
                <param name="maxLength" type="integer" value="30" label="Maximum bond count for a pair" help="">
                    <validator type="in_range" min="1" />
                </param>
            </when>
            <when value="--maccs166" />
            <when value="--substruct" />
        </conditional>

    </inputs>
    <outputs>
        <data name="outfile" format="fps" />
    </outputs>
    <tests>
        <!-- FP2 -->
        <test>
            <param name="infile" value="CID_2244.sdf" ftype="sdf" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--FP2" />
            </conditional>
            <output name="outfile" file="CID_2244_FP2.fps" ftype="fps" lines_diff="4"/>
        </test>
        <test>
            <param name="infile" value="CID_2244.smi" ftype="smi" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--FP2" />
            </conditional>
            <output name="outfile" file="CID_2244_FP2.fps" ftype="fps" lines_diff="4"/>
        </test>
        <!-- FP3 -->
        <test>
            <param name="infile" value="CID_2244.sdf" ftype="sdf" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--FP3" />
            </conditional>
            <output name="outfile" file="CID_2244_FP3.fps" ftype="fps" lines_diff="4"/>
        </test>
        <test>
            <param name="infile" value="CID_2244.smi" ftype="smi" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--FP3" />
            </conditional>
            <output name="outfile" file="CID_2244_FP3.fps" ftype="fps" lines_diff="4"/>
        </test>
        <!-- FP4 -->
        <test>
            <param name="infile" value="CID_2244.sdf" ftype="sdf" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--FP4" />
            </conditional>
            <output name="outfile" file="CID_2244_FP4.fps" ftype="fps" lines_diff="4"/>
        </test>
        <test>
            <param name="infile" value="CID_2244.smi" ftype="smi" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--FP4" />
            </conditional>
            <output name="outfile" file="CID_2244_FP4.fps" ftype="fps" lines_diff="4"/>
        </test>
        <!-- MACCS -->
        <test>
            <param name="infile" value="CID_2244.sdf" ftype="sdf" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--MACCS" />
            </conditional>
            <output name="outfile" file="CID_2244_MACCS.fps" ftype="fps" lines_diff="4"/>
        </test>
        <test>
            <param name="infile" value="CID_2244.smi" ftype="smi" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--MACCS" />
            </conditional>
            <output name="outfile" file="CID_2244_MACCS.fps" ftype="fps" lines_diff="4"/>
        </test>
        <!-- RDKit2fps -->
        <test>
            <param name="infile" value="CID_2244.smi" ftype="smi" />
            <conditional name="fp_opts">
                <param name="fp_opts_selector" value="--torsions" />
            </conditional>
            <param name="fp_opts.fpSize" value="2048" />
            <param name="fp_opts.targetSize" value="4" />
            <output name="outfile" file="CID_2244_torsions.fps" ftype="fps" lines_diff="4"/>
        </test>
    </tests>
    <help>
<![CDATA[

.. class:: infomark

**What this tool does**

This tool uses chemfp to calculate molecular fingerprints, supporting a number of common file formats. Chemfp uses OpenBabel, OpenEye and RDKit.

For more information check the websites listed below::

	- http://www.rdkit.org/docs/GettingStartedInPython.html#fingerprinting-and-molecular-similarity
	- http://openbabel.org/wiki/Tutorial:Fingerprints

-----

.. class:: infomark

**Input**

FPS fingerprint file format

* Example::

	      - SD-File

		28434379
		  -OEChem-02031205132D

		 37 39  0     0  0  0  0  0  0999 V2000
		    8.1648   -1.8842    0.0000 O   0  0  0  0  0  0  0  0  0  0  0  0
		    6.0812   -0.2134    0.0000 N   0  0  0  0  0  0  0  0  0  0  0  0
		    6.0812   -1.8229    0.0000 N   0  0  0  0  0  0  0  0  0  0  0  0
		    2.5369   -2.0182    0.0000 N   0  0  0  0  0  0  0  0  0  0  0  0
		    6.3919    0.7371    0.0000 C   0  0  0  0  0  0  0  0  0  0  0  0
		    7.3704    0.9433    0.0000 C   0  0  0  0
		    ......
		  1 15  1  0  0  0  0
		  1 35  1  0  0  0  0
		  2  5  1  0  0  0  0
		  2 11  1  0  0  0  0
		  2 12  1  0  0  0  0
		  3 12  2  0  0  0  0
		  3 13  1  0  0  0  0
		  4 18  1  0  0  0  0
		  ......

			>PUBCHEM_COMPOUND_CID<
			28434379

			> <PUBCHEM_COMPOUND_CANONICALIZED>
			1

			> <PUBCHEM_CACTVS_COMPLEXITY>
			280

			> <PUBCHEM_CACTVS_HBOND_ACCEPTOR>
			2

			> <PUBCHEM_CACTVS_HBOND_DONOR>
			2

			> <PUBCHEM_CACTVS_ROTATABLE_BOND>
			2

			> <PUBCHEM_CACTVS_SUBSKEYS>
			AAADceBzIAAAAAAAAAAAAAAAAAAAAWAAAAAwYAAAAAAAAFgB8AAAHgAQCAAACCjhlwYx0LdMEgCgASZiZASCgC0hEqAJ2CA4dJiKeKLA2dGUJAhokALYyCcQAAAAAACAAAQAACAAAQAACAAAQAAAAAAAAA==

			>

		- type : FP2

-----

.. class:: infomark

**Output**

* Example::

	#FPS1
	#num_bits=1021
	#type=OpenBabel-FP2/1
	#software=OpenBabel/2.3.0
	#source=/tmp/dataset_409.dat.sdf
	#date=2012-02-03T11:13:39
	c0000000000008c0000846000400000000000010800000000000004000000000100010000700802170000018000000c
	0010000000020600208008000008000000c000c02c00002000000c00000100000008001400c800001c0180000000300
	10000000000080000000c0000060000c0000060810000010000000800102000000	28434379


]]>
    </help>
    <citations>
        <citation type="doi">10.1186/1758-2946-3-33</citation>
        <citation type="doi">10.1186/1758-2946-5-S1-P36</citation>
        <citation type="bibtex">
            @electronic{rdkit,
                title = {RDKit: Open-source cheminformatics},
                url ={http://www.rdkit.org}
            }
        </citation>
    </citations>
</tool>