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
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,7 @@ Options:
37
37
--tsv Output primary result file in tsv format
38
38
--only-db Create binary database and exit
39
39
--skip-db Don't create the binary database for the reference sequences
40
+
-c, --clean Remove binary database and checkpoint files after a successful run
40
41
--raw-confidence Don't adjust confidence values for 1 exact match
41
42
-t, --threads <THREADS> Number of threads
42
43
If 0, uses all available threads [default: 0]
@@ -141,7 +142,9 @@ This option does not require `-i` to be specified and `raxtax` will terminate af
141
142
`--skip-db` will skip the creation of the binary database.
142
143
This is only recommended if you run with that database only once or it is very small.
143
144
144
-
`--raw-confidence` will output the real confidence values if there is 1 exact match instead of setting the confidence to 1.0.
145
+
`--clean` will remove the binary database and checkpoint files (`raxtax.json` and `raxtax.ckp`) after a successful run. This is mainly intended for long runs that might get interrupted, but the binary database is not needed afterwards.
146
+
147
+
`--raw-confidence` will output the real confidence values if there is 1 exact match instead of setting the confidence to 1.0.
145
148
This is mostly a debugging option, but might come in handy for specific usecases.
146
149
147
150
`--threads` may be omitted most of the time and `raxtax` will use as many cores as your system has available. Because the analysis is _embarrassingly parallel_, this is a sensible default.
@@ -167,14 +170,15 @@ An error message will be displayed if too many reference sequences are used with
167
170
168
171
## Checkpointing
169
172
170
-
Since v.1.3.0 `raxtax` comes with default checkpointing to prevent data loss in case of unforeseen crashes (i.e. terminated by the OS scheduler). `raxtax` will create a binary database of the reference sequences in the output directory for faster loading on subsequent runs (disable this with `--skip-db`). Then, every time a batch of queries finishes, they will be written to the output files.
173
+
Since v.1.3.0 `raxtax` comes with default checkpointing to prevent data loss in case of unforeseen crashes (i.e. terminated by the OS scheduler). `raxtax` will create a binary database of the reference sequences in the output directory for faster loading on subsequent runs (disable this with `--skip-db`). Then, every time a query finishes, it will be written to the output files.
171
174
To restart from the latest checkpoint, run `raxtax` with the same options for `--raw_confidence <bool> --skip_exact_matches <bool> --tsv <bool> --prefix <path>`.
172
175
The database path will be recovered from the checkpoint file.
173
176
The log file and result files will be appended to in subsequent runs.
174
177
175
178
**Caution**: Running with `--redo` will override any checkpoints!
176
179
177
-
**Advanced usage**: Checkpoint information is saved in `<prefix>/raxtax.ckp` in JSON format and therefore can be manually adjusted to make the checkpoint cooperate if e.g. the database file was moved or some queries need to be re-run.
180
+
**Advanced usage**: Checkpoint information is saved in `<prefix>/raxtax.json` in JSON format and therefore can be manually adjusted to make the checkpoint cooperate if e.g. the database file was moved.
181
+
The list of already processed queries is kept in `<prefix>/raxtax.ckp` and can be adjusted if some queries need to be re-run.
0 commit comments