Skip to content

Commit d3bcbd5

Browse files
authored
Update readme for release
1 parent 357bc96 commit d3bcbd5

File tree

1 file changed

+36
-9
lines changed

1 file changed

+36
-9
lines changed

README.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ThermoRawFileParser
22

33
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:
4-
* MGF: MS2 and MS3 spectra
5-
* mzML and indexed mzML: MS1, MS2 and MS3 spectra
4+
* MGF
5+
* mzML and indexed mzML
66
* Apache Parquet: under development
77

88
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):
@@ -27,17 +27,22 @@ Click [here](https://github.com/compomics/ThermoRawFileParser/releases) to go to
2727
You can find the ThermoRawFileParserGUI [here](https://github.com/compomics/ThermoRawFileParserGUI).
2828

2929
## Usage
30+
3031
```
3132
mono ThermoRawFileParser.exe -i=/home/user/data_input/raw_file.raw -o=/home/user/data_input/output/ -f=0 -g -m=0
3233
```
34+
3335
with only the mimimal required argument `-i` or `-d` this becomes
36+
3437
```
3538
mono ThermoRawFileParser.exe -i=/home/user/data_input/raw_file.raw
3639
```
3740
or
41+
3842
```
3943
mono ThermoRawFileParser.exe -d=/home/user/data_input/
4044
```
45+
4146
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` (0 for MGF, 1 for mzML, 2 for indexed mzML, 3 for Parquet) or both. Use the `-p` flag to disable the thermo native peak picking.
4247

4348
```
@@ -85,8 +90,9 @@ optional subcommands are xic|query (use [subcommand] -h for more info]):
8590
enabled.
8691
-a, --allDetectors Extract additional detector data: UV/PDA etc
8792
-l, --logging=VALUE Optional logging level: 0 for silent, 1 for
88-
verbose; both numeric and text (case insensitive)
89-
value recognized.
93+
verbose, 2 for default, 3 for warning, 4 for
94+
error; both numeric and text (case insensitive)
95+
value recognized.
9096
-e, --ignoreInstrumentErrors
9197
Ignore missing properties by the instrument.
9298
-x, --excludeExceptionData Exclude reference and exception data
@@ -96,6 +102,8 @@ optional subcommands are xic|query (use [subcommand] -h for more info]):
96102
end intervals (1-) are allowed
97103
-P, --mgfPrecursor Include precursor scan number in MGF file TITLE
98104
-N, --noiseData Include noise data in mzML output
105+
-w, --warningsAreErrors Return non-zero exit code for warnings; default
106+
only for errors
99107
-u, --s3_url[=VALUE] Optional property to write directly the data into
100108
S3 Storage.
101109
-k, --s3_accesskeyid[=VALUE]
@@ -112,9 +120,11 @@ A (java) graphical user interface is also available [here](https://github.com/co
112120

113121
### query subcommand
114122
Enables the retrieval spectra by (a) scan number(s) in [PROXI format](https://github.com/HUPO-PSI/proxi-schemas).
123+
115124
```
116125
mono ThermoRawFileParser.exe query -i=/home/user/data_input/raw_file.raw -o=/home/user/output.json n="1-5, 20, 25-30"
117126
```
127+
118128
```
119129
ThermoRawFileParser.exe query --help
120130
usage is:
@@ -127,13 +137,22 @@ usage is:
127137
Thermo library. By default peak picking is
128138
enabled.
129139
-s, --stdout Pipes the output into standard output. Logging is
130-
being turned off.
140+
being turned off
141+
-w, --warningsAreErrors Return non-zero exit code for warnings; default
142+
only for errors
143+
-l, --logging=VALUE Optional logging level: 0 for silent, 1 for
144+
verbose, 2 for default, 3 for warning, 4 for
145+
error; both numeric and text (case insensitive)
146+
value recognized.
131147
```
148+
132149
### xic subcommand
133150
Return one or more chromatograms based on query JSON input.
151+
134152
```
135153
mono ThermoRawFileParser.exe xic -i=/home/user/data_input/raw_file.raw -j=/home/user/xic_input.json
136154
```
155+
137156
```
138157
ThermoRawFileParser.exe xic --help
139158
usage is:
@@ -151,15 +170,23 @@ usage is:
151170
encoded string.
152171
-s, --stdout Pipes the output into standard output. Logging is
153172
being turned off.
173+
-w, --warningsAreErrors Return non-zero exit code for warnings; default
174+
only for errors
175+
-l, --logging=VALUE Optional logging level: 0 for silent, 1 for
176+
verbose, 2 for default, 3 for warning, 4 for
177+
error; both numeric and text (case insensitive)
178+
value recognized.
154179
```
180+
155181
Provide one of the following filters:
156-
* M/Z and tolerance (tolerance unit optional, default `ppm`)
182+
* M/Z and tolerance (tolerance unit optional, defaults to `ppm`)
157183
* M/Z start and end
158-
* sequence and tolerance (tolerance unit optional, default `ppm`)
159-
160-
with optional parameters start en end retention time and filter (thermo filter string, defaults to `ms`)
184+
* sequence and tolerance (tolerance unit optional, defaults to `ppm`)
185+
186+
optionally one can define starting and ending retention times and thermo filter string (defaults to `ms`)
161187

162188
An example input JSON file:
189+
163190
```
164191
[
165192
{

0 commit comments

Comments
 (0)