Skip to content

Commit 2f290c4

Browse files
author
Noah Wahl
committed
chore(version): bump version and update readme
1 parent a9e3bcc commit 2f290c4

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "raxtax"
3-
version = "1.3.0"
3+
version = "1.4.0"
44
authors = ["Noah Wahl <noah.ares99@gmail.com>"]
55
edition = "2021"
66
repository = "https://github.com/noahares/raxtax"

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Options:
3737
--tsv Output primary result file in tsv format
3838
--only-db Create binary database and exit
3939
--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
4041
--raw-confidence Don't adjust confidence values for 1 exact match
4142
-t, --threads <THREADS> Number of threads
4243
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
141142
`--skip-db` will skip the creation of the binary database.
142143
This is only recommended if you run with that database only once or it is very small.
143144

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.
145148
This is mostly a debugging option, but might come in handy for specific usecases.
146149

147150
`--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
167170

168171
## Checkpointing
169172

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.
171174
To restart from the latest checkpoint, run `raxtax` with the same options for `--raw_confidence <bool> --skip_exact_matches <bool> --tsv <bool> --prefix <path>`.
172175
The database path will be recovered from the checkpoint file.
173176
The log file and result files will be appended to in subsequent runs.
174177

175178
**Caution**: Running with `--redo` will override any checkpoints!
176179

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.
178182
**Do this at your own risk!**
179183

180184
## References

0 commit comments

Comments
 (0)