Skip to content

Commit

Permalink
Bump the version, update the readme, and a couple output format adjus…
Browse files Browse the repository at this point in the history
…tments
  • Loading branch information
FarmGeek4Life committed Apr 16, 2019
1 parent 76dfeeb commit 7cda502
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 6 deletions.
2 changes: 1 addition & 1 deletion MzidToTsvConverter/MzidToTsvConverter.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<RootNamespace>MzidToTsvConverter</RootNamespace>
<AssemblyName>MzidToTsvConverter</AssemblyName>
<PackageId>MzidToTsvConverter</PackageId>
<Version>1.2.4</Version>
<Version>1.3.0</Version>
<AssemblyVersion>$(Version)</AssemblyVersion>
<FileVersion>$(Version)</FileVersion>
<Description>Converts mzid[.gz] files to the MS-GF+ tsv format. Designed for MS-GF+ mzid files (looks for EValue and SpecEValue scores)</Description>
Expand Down
4 changes: 2 additions & 2 deletions MzidToTsvConverter/PeptideMatch.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public string FragMethod
}

public double Precursor => Identification.ExperimentalMz;
public double IsotopeError => Identification.IsoError;
public int IsotopeError => Identification.IsoError;

public double PrecursorErrorPpm
{
Expand Down Expand Up @@ -61,7 +61,7 @@ public PeptideMatchMap(bool noExtendedFields = false)
Map(x => x.ScanNum).Name("ScanNum").Index(index++);
if (!noExtendedFields)
{
Map(x => x.ScanStartTimeMinutes).Name("ScanTime(Min)").Index(index++);
Map(x => x.ScanStartTimeMinutes).Name("ScanTime(Min)").Index(index++).TypeConverterOption.Format("0.0####");
}
Map(x => x.FragMethod).Name("FragMethod").Index(index++);
Map(x => x.Precursor).Name("Precursor").Index(index++).TypeConverterOption.Format("0.0####");
Expand Down
19 changes: 16 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ MzidToTsvConverter uses PSI_Interface.dll to read the mzid file.
`MzidToTsvConverter -mzid:"mzid path" [-tsv:"tsv output path"] [-unroll|-u] [-showDecoy|-sd] [-maxSpecEValue] [-maxEValue] [-maxEValue]`

### Required parameters:
`-mzid:path`
`-mzid:path`
* Path to the .mzid or .mzid.gz file. If the path has spaces, it must be in quotes.
* Alternatively, the path to a directory with .mzid or .mzid.gz files. In this case, all .mzid files in the directory will be converted to .tsv

Expand All @@ -32,6 +32,9 @@ MzidToTsvConverter uses PSI_Interface.dll to read the mzid file.
* Signifies that decoy results should be included in the output .tsv file.
* Decoy results have protein names that start with XXX_

`-singleResult` or `-1`
* Only output one result per spectrum

`-maxSpecEValue` or `-MaxSpecE` or `-SpecEValue`
* Filter the results, excluding those with a SpecEValue greater than this threshold

Expand All @@ -42,6 +45,15 @@ MzidToTsvConverter uses PSI_Interface.dll to read the mzid file.
* Filter the results, excluding those with a QValue greater than this threshold
* For example, -qvalue:0.001

`-noExtended` or `-ne`
* Do not output the extended fields (e.g., Scan Time). When this flag is specified the output will have the same columns as the MS-GF+ MzidToTsv output, and be a near match when run with the same parameters

`-recurse` or `-r`
* If mzid path is a directory, specifying this will cause mzid files in subdirectories to also be converted.

`-skipDupIds`
* If there are issues converting a file due to \"duplicate ID\" errors, specifying this will cause the duplicate IDs to be ignored, at the likely cost of some correctness.

## Output Columns

The columns in the .tsv file created by the MzidToTsvConverter are:
Expand All @@ -51,6 +63,7 @@ The columns in the .tsv file created by the MzidToTsvConverter are:
| #SpecFile | Spectrum file name | Dataset.mzML |
| SpecID | Spectrum ID | controllerType=0 controllerNumber=1 scan=16231 |
| ScanNum | Scan number | 16231 |
| ScanTime(Min) | (Can be disable with switch `-ne`) Scan Start time, minutes | 52.534 |
| FragMethod | Fragmentation method for the given MS/MS spectrum. Will be CID, ETD, or HCD. However, when spectra from the same precursor are merged, fragmentation methods of merged spectra will be shown in the form "FragMethod1/FragMethod2/..." (e.g. CID/ETD, CID/HCD/ETD). | HCD |
| Precursor | m/z value of the precursor ion | 767.04388 |
| IsotopeError | Isotope Error, indicating which isotope in the isotopic distribution the parent ion m/z corresponds to. Typically 0, indicating the first isotope. If 1, that means the second isotope was chosen for fragmentation. | 0 |
Expand Down Expand Up @@ -80,8 +93,8 @@ Website: https://omics.pnl.gov/ or https://panomics.pnnl.gov/

## License

The MzidToTsvConverter is licensed under the 2-Clause BSD License;
you may not use this file except in compliance with the License. You may obtain
The MzidToTsvConverter is licensed under the 2-Clause BSD License;
you may not use this file except in compliance with the License. You may obtain
a copy of the License at https://opensource.org/licenses/BSD-2-Clause

Copyright 2018 Battelle Memorial Institute

0 comments on commit 7cda502

Please sign in to comment.