feature: introduce config file for JPK tags#124
Conversation
68fe483 to
fd1dbca
Compare
Off the back of #118 (thanks @derollins) I've parameterised the JPK tags that were introduced into `AFMReader/default_config.yaml` and load these by default when using `AFMReader.load_jpl()`. A parameter is introduced to that function which allows users to specify their own configuration file should they wish to use alternative tags. - Copies the `read_yaml()` function and tests from TopoStats. - Brief description of configuration file and structure added to `docs/usage.md` (where some tables were also aligned by Emacs). Exiting `tests/test_jpk.py` pass.
fd1dbca to
6d7748a
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #124 +/- ##
==========================================
+ Coverage 74.62% 75.74% +1.11%
==========================================
Files 8 9 +1
Lines 607 705 +98
==========================================
+ Hits 453 534 +81
- Misses 154 171 +17 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
derollins
left a comment
There was a problem hiding this comment.
Only suggestion is to add an extra value for completeness, have done it myself locally but don't know if I can change it here.
Thanks for the feedback @derollins 👍
|
Brilliant, thanks for the feedback @derollins 👍 I've added in |
derollins
left a comment
There was a problem hiding this comment.
Captures all the .jpk file tags used to read the files and has a clear config file for the values of these tags. I'm just unsure about how alternative config files can be used, since this is a library rather than an executable programme.
Off the back of #118 (thanks @derollins) I've parameterised the JPK tags that were introduced into
AFMReader/default_config.yamland load these by default when usingAFMReader.load_jpk(). A parameter is introducedto that function (
confi_path) which allows users to specify their own configuration file should they wish to use alternative tags.read_yaml()function and tests from TopoStats.docs/usage.md(where some tables were also aligned byEmacs).
Exiting
tests/test_jpk.pypass.I envisage this being an extensible and flexible way of users being able to handle parameters changing the array of file types that
exist now and in the future and it should be easy to extend to other file formats.