Skip to content

Commit

Permalink
Update the Readme and increment the version
Browse files Browse the repository at this point in the history
  • Loading branch information
alchemistmatt committed Nov 16, 2018
1 parent 285bab7 commit db8ddf7
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 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.3</Version>
<Version>1.2.4</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
3 changes: 3 additions & 0 deletions MzidToTsvConverter/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@ static int Main(string[] args)
#endif
var converter = new MzidToTsvConverter();
converter.ConvertToTsv(options);

Console.WriteLine();
Console.WriteLine("Conversion finished!");
System.Threading.Thread.Sleep(700);

return 0;
#if !DEBUG
}
Expand Down
15 changes: 13 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,34 @@ MzidToTsvConverter uses PSI_Interface.dll to read the mzid file.

## Syntax

`MzidToTsvConverter -mzid:"mzid path" [-tsv:"tsv output path"] [-unroll|-u] [-showDecoy|-sd]`
`MzidToTsvConverter -mzid:"mzid path" [-tsv:"tsv output path"] [-unroll|-u] [-showDecoy|-sd] [-maxSpecEValue] [-maxEValue] [-maxEValue]`

### Required parameters:
`-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

### Optional parameters:
`-tsv:path`
* Path to the tsv file to be written. If not specified, will be created in the same location as the .mzid file.

`-unroll` or `-u`
* Signifies that results should be unrolled: one line per unique peptide/protein combination in each spectrum identification
* Signifies that results should be unrolled, giving one line per unique peptide/protein combination in each spectrum identification

`-showDecoy` or `-sd`
* Signifies that decoy results should be included in the output .tsv file.
* Decoy results have protein names that start with XXX_

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

`-maxEValue`or `-MaxE` or `-EValue`
* Filter the results, excluding those with an EValue greater than this threshold

`-maxQValue` or `-MaxQ` or `-QValue`
* Filter the results, excluding those with a QValue greater than this threshold
* For example, -qvalue:0.001

## Output Columns

The columns in the .tsv file created by the MzidToTsvConverter are:
Expand Down

0 comments on commit db8ddf7

Please sign in to comment.