<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE knimeNode PUBLIC "-//UNIKN//DTD KNIME Node 2.0//EN" "http://www.knime.org/Node.dtd">
<knimeNode icon="generic_node.png" type="Manipulator">
    <name>IDFilter</name>
    
    <shortDescription>
        Filters results from protein or peptide identification engines based on different criteria.
    </shortDescription>
    
    <fullDescription>
        <intro><p>Filters results from protein or peptide identification engines based on different criteria.</p>
		<p>
			<a href="http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_IDFilter.html">Web Documentation for IDFilter</a>
		</p>

        </intro>
        
		<option name="version">Version of the tool that generated this parameters file.</option>
		<option name="length">Keep only peptide hits with a sequence length in this range.</option>
		<option name="charge">Keep only peptide hits with charge states in this range.</option>
		<option name="var_mods">Keep only peptide hits with variable modifications (as defined in the 'SearchParameters' section of the input file).</option>
		<option name="unique">If a peptide hit occurs more than once per peptide ID, only one instance is kept.</option>
		<option name="unique_per_protein">Only peptides matching exactly one protein are kept. Remember that isoforms count as different proteins!</option>
		<option name="keep_unreferenced_protein_hits">Proteins not referenced by a peptide are retained in the IDs.</option>
		<option name="remove_decoys">Remove proteins according to the information in the user parameters. Usually used in combination with 'delete_unreferenced_peptide_hits'.</option>
		<option name="delete_unreferenced_peptide_hits">Peptides not referenced by any protein are deleted in the IDs. Usually used in combination with 'score:prot' or 'thresh:prot'.</option>
		<option name="log">Name of log file (created only when specified)</option>
		<option name="debug">Sets the debug level</option>
		<option name="threads">Sets the number of threads allowed to be used by the TOPP tool</option>
		<option name="no_progress">Disables progress logging to command line</option>
		<option name="force">Overwrite tool specific checks.</option>
		<option name="test">Enables the test mode (needed for internal use only)</option>
		<option name="rt">Retention time range to extract.</option>
		<option name="mz">Mass-to-charge range to extract.</option>
		<option name="pep">The score which should be reached by a peptide hit to be kept.</option>
		<option name="prot">The score which should be reached by a protein hit to be kept. Use in combination with 'delete_unreferenced_peptide_hits' to remove affected peptides.</option>
		<option name="pep">Keep a peptide hit only if its score is above this fraction of the peptide significance threshold.</option>
		<option name="prot">Keep a protein hit only if its score is above this fraction of the protein significance threshold. Use in combination with 'delete_unreferenced_peptide_hits' to remove affected peptides.</option>
		<option name="protein_accessions">All peptides that do not reference at least one of the provided protein accession are removed.
Only proteins of the provided list are retained.</option>
		<option name="ignore_modifications">Compare whitelisted peptides by sequence only.</option>
		<option name="modifications">Keep only peptides with sequences that contain (any of) the selected modification(s)</option>
		<option name="protein_accessions">All peptides that reference at least one of the provided protein accession are removed.
Only proteins not in the provided list are retained.</option>
		<option name="ignore_modifications">Compare blacklisted peptides by sequence only.</option>
		<option name="modifications">Remove all peptides with sequences that contain (any of) the selected modification(s)</option>
		<option name="p_value">Retention time filtering by the p-value predicted by RTPredict.</option>
		<option name="p_value_1st_dim">Retention time filtering by the p-value predicted by RTPredict for first dimension.</option>
		<option name="error">Filtering by deviation to theoretical mass (disabled for negative values).</option>
		<option name="unit">Absolute or relative error.</option>
		<option name="n_peptide_hits">Keep only the 'n' highest scoring peptide hits per spectrum (for n &gt; 0).</option>
		<option name="n_protein_hits">Keep only the 'n' highest scoring protein hits (for n &gt; 0).</option>
		<option name="strict">Keep only the highest scoring peptide hit.
Similar to n_peptide_hits=1, but if there are ties between two or more highest scoring hits, none are kept.</option>
		<option name="n_to_m_peptide_hits">Peptide hit rank range to extracts</option>

    </fullDescription>
    
    <ports>
		<inPort index="0" name="in [idXML]">input file  [idXML]</inPort>
		<inPort index="1" name="proteins [fasta]">Filename of a FASTA file containing protein sequences.#br#All peptides that are not referencing a protein in this file are removed.#br#All proteins whose accessions are not present in this file are removed. [fasta,opt.]</inPort>
		<inPort index="2" name="peptides [idXML]">Only peptides with the same sequence and modification assignment as any peptide in this file are kept. Use with 'whitelist:ignore_modifications' to only compare by sequence.#br# [idXML,opt.]</inPort>
		<inPort index="3" name="proteins [fasta]">Filename of a FASTA file containing protein sequences.#br#All peptides that are referencing a protein in this file are removed.#br#All proteins whose accessions are present in this file are removed. [fasta,opt.]</inPort>
		<inPort index="4" name="peptides [idXML]">Peptides with the same sequence and modification assignment as any peptide in this file are filtered out. Use with 'blacklist:ignore_modifications' to only compare by sequence.#br# [idXML,opt.]</inPort>
		<outPort index="0" name="out [idXML]">output file  [idXML]</outPort>
 </ports>
    <views>
        <view index="0" name="IDFilter Std Output">The text sent to standard out during the execution of IDFilter.</view>
        <view index="1" name="IDFilter Error Output">The text sent to standard error during the execution of IDFilter. (If it appears in gray, it's the output of a previously failing run which is preserved for your trouble shooting.)</view>
    </views>    
</knimeNode>
