search

JensUweUlrich / ReadBouncer

Fast and scalable nanopore adaptive sampling
GNU General Public License v3.0
33 stars 2 forks source link

TOML File Key in README Incorrect #45

Closed syncrotron closed 2 years ago

syncrotron commented 2 years ago

Through attempting to get ReadBouncer up and running with a custom TOML file, I noticed that within the readme file "Building the database" section the TOML key output_dir is referenced. If a TOML is provided to Breadboard with this key, the following error is provided:

Error in /my/home/path/readboucer_conf.toml
[error] key "output_directory" not found in the top-level table
 --> /path/to/config/readboucer_conf.toml
   |
 1 | usage         = "build"
   | ^--- the top-level table starts here

The reference output_dir instead of output_directory as a TOML key appears to be an error.

JensUweUlrich commented 2 years ago

Thanks for pointing that out. That's an error in the documentation. The parameter should be output_directory. I will change that immediately in the documentation.