.\" Man page generated from reStructuredText.
.
.TH TOPFD 1 "20200521" "1" "TopPIC suite"
.SH NAME
topfd \- Top-down mass spectral Feature Detection
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
topfd [options] spectrum\-file\-names
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
TopFD (Top\-down mass spectral Feature Detection) is a software tool for top\-down
spectral deconvolution, which groups top\-down mass spectral peaks into
isotopomer envelopes and converts isotopomer envelopes to monoisotopic neutral
masses. In addition, it extracts proteoform features from MS1 spectra.
.INDENT 0.0
.IP 1. 3
Input
.sp
The input of TopFD is mass spectrometry data files in the mzXML or mzML
format. Raw mass spectral data generated from various mass spectrometers can
be converted to mzML or mzXML files using msconvert.
.IP 2. 3
Output
.sp
TopFD outputs two LC/MS feature text files with a file extension "feature",
one LC/MS feature file with a file extension "xml", and a deconvoluted mass
spectral data file for MS/MS spectra in the msalign format with a file
extension "msalign", which is similar to the MGF file format. In addition,
TopFD creates two folders containing java scripts files of spectral data for
spectral visualization and other files generated in spectral deconvolution.
For example, when the input file name is spectra.mzML, the output includes:
.INDENT 3.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
spectra_ms1.feature: a feature file containing LC/MS features.
.IP \(bu 2
spectra_ms2.feature: a feature file containing MS/MS scan IDs and their corresponding LC/MS feature IDs.
.IP \(bu 2
spectra_feature.xml: a feature file containing LC/MS features in the xml format.
.IP \(bu 2
spectra_ms2.msalign: a list of deconvoluted MS/MS spectra.
.IP \(bu 2
spectra_file: a folder containing deconvoluted MS1 spectra and annotations of LC/MS data.
.IP \(bu 2
spectra_html: a folder containing java script files of MS1 and MS/MS data for spectral visualization.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH OPTIONS
.sp
\-h [ \-\-help ] Print the help message.
.sp
\-c [ \-\-max\-charge ] Set the maximum charge state of precursor and fragment ions. The default value is 30.
.sp
\-m [ \-\-max\-mass ] Set the maximum monoisotopic mass of precursor and fragment ions. The default value is 100,000 Dalton.
.sp
\-e [ \-\-mz\-error ] Set the error tolerance of m/z values of spectral peaks. The default value is 0.02 m/z.
.sp
\-r [ \-\-ms\-one\-sn\-ratio ] Set the signal/noise ratio for MS1 spectra. The default value is 3.
.sp
\-t [ \-\-ms\-two\-sn\-ratio ] Set the signal/noise ratio for MS/MS spectra. The default value is 1.
.sp
\-w [ \-\-precursor\-window ] Set the precursor isolation window size. The default value is 3.0 m/z.
.sp
\-o [ \-\-missing\-level\-one ] Specify that the input file does not contain MS1 spectra.
.SH EXAMPLES
.INDENT 0.0
.IP \(bu 2
Deconvolute a centroid data file spectra.mzML and output four files: spectra_ms2.msalign, spectra_ms1.feature, spectra_ms2.feature, spectra_feature.xml.
.sp
topfd spectra.mzML
.IP \(bu 2
Deconvolute two centroid data files spectra1.mzML and spectra2.mzML and output three files for each input data file.
.sp
topfd spectra1.mzML spectra2.mzML
.IP \(bu 2
Deconvolute all centroid data files in the current folder.
.sp
topfd *.mzML
.IP \(bu 2
Deconvolute a centroid data file spectra.mzML that does not contain MS1 spectra.
.sp
topfd \-o spectra.mzML
.IP \(bu 2
Deconvolute a centroid data file spectra.mzML with a precursor isolation window size 2 m/z.
.sp
topfd \-w 2 spectra.mzML
.IP \(bu 2
Deconvolute a centroid data file spectra.mzML with a signal/noise ratio 2 for MS1 spectra.
.sp
topfd \-r 2 spectra.mzML
.IP \(bu 2
Deconvolute a centroid data file spectra.mzML with the following settings: the maximum charge state: 50, the maximum mass: 30,000 Dalton, and the signal/noise ratio for MS/MS spectra: 2.
.sp
topfd \-c 50 \-m 30000 \-t 2 spectra.mzML
.UNINDENT
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
toppic (1)
.IP \(bu 2
topmg (1)
.IP \(bu 2
topdiff (1)
.UNINDENT
.SH MAN PAGE PRODUCTION
.sp
This man page was written by Filippo Rusconi <\fI\%lopippo@debian.org\fP>. Material was
taken from \fI\%http://proteomics.informatics.iupui.edu/software/toppic/manual.html\fP\&.
.SH AUTHOR
Filippo Rusconi and upstream authors (Dr. Xiaowen
Liu's Lab at Indiana University-Purdue University Indianapolis and
others)
.SH COPYRIGHT
Filippo Rusconi and Indiana University-Purdue University
Indianapolis
.\" Generated by docutils manpage writer.
.