You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-9Lines changed: 22 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,32 @@
1
1
# ThermoRawFileParser
2
2
3
-
Wrapper around the .net (C#) ThermoFisher ThermoRawFileReader library for running on Linux with mono (works on Windows too). It takes a thermo RAW file as input and outputs a metadata file and the spectra in 3 possible formats:
3
+
A tool allowing reading Thermo RAW mass spectrometer files and converting to common open formats on all platforms supporting .NET Core.
4
+
5
+
Supported formats:
4
6
* MGF
5
7
* mzML and indexed mzML
6
-
* Apache Parquet: under development
8
+
* Apache Parquet
9
+
10
+
Version before 1.5.0 require Mono to run on Linux and Mac.
7
11
8
12
As of version 1.2.0, 2 subcommands are available (shoutout to the [eubic 2020 developers meeting](https://eubic-ms.org/events/2020-developers-meeting/), see [usage](#usage) for examples):
9
13
* query: returns one or more spectra in JSON PROXI by scan number(s)
10
14
* xic: returns chromatogram data based on JSON filter input
11
15
12
-
These features are still under development, remarks or suggestions are more than welcome.
* Hulstaert N, Shofstahl J, Sachsenberg T, Walzer M, Barsnes H, Martens L, Perez-Riverol Y: _ThermoRawFileParser: Modular, Scalable, and Cross-Platform RAW File Conversion_[[PMID 31755270](https://www.ncbi.nlm.nih.gov/pubmed/31755270)].
18
20
* If you use ThermoRawFileParser as part of a publication, please include this reference.
19
21
20
-
## (Linux) Requirements
22
+
## Requirements
23
+
24
+
### Current version
25
+
Release page provide self-contained releases for OSX, Linux, and Windows and framework-based release. Framework-based release requires [.NET 8 runtime](https://dotnet.microsoft.com/en-us/download/dotnet/8.0/runtime).
26
+
27
+
For developers: [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) is required to build the tool.
28
+
29
+
### Prior to 1.5.0
21
30
[Mono](https://www.mono-project.com/download/stable/#download-lin) (install mono-complete if you encounter "assembly not found" errors).
22
31
23
32
## Download
@@ -33,21 +42,23 @@ You can read release notes (starting from version 1.1.7) in the [wiki page](http
For running on Windows, omit `mono`. The optional parameters only work in the -option=value format. The tool can output some RAW file metadata `-m=0|1` (0 for JSON, 1 for TXT) and the spectra file `-f=0|1|2|3|4` (0 for MGF, 1 for mzML, 2 for indexed mzML, 3 for Parquet, 4 for no output) or both. Use the `-p` flag to disable the thermo native peak picking.
59
+
When running framework-based version use `dotnet ThermoRawFileParser.dll` instead.
60
+
61
+
The optional parameters only work in the -option=value format. The tool can output some RAW file metadata `-m=0|1` (0 for JSON, 1 for TXT) and the spectra file `-f=0|1|2|3|4` (0 for MGF, 1 for mzML, 2 for indexed mzML, 3 for Parquet, 4 for no output) or both. Use the `-p` flag to disable the thermo native peak picking.
51
62
52
63
```
53
64
Usage is ThermoRawFileParser.exe [subcommand] [options]
@@ -107,6 +118,8 @@ optional subcommands are xic|query (use [subcommand] -h for more info]):
107
118
end intervals (1-) are allowed
108
119
-P, --mgfPrecursor Include precursor scan number in MGF file TITLE
109
120
-N, --noiseData Include noise data in mzML output
121
+
-C, --chargeData Include instrument detected charge states in mzML
122
+
output (only for high resolution centroided data)
110
123
-w, --warningsAreErrors Return non-zero exit code for warnings; default
111
124
only for errors
112
125
-u, --s3_url[=VALUE] Optional property to write directly the data into
0 commit comments