ImperialCollegeLondon / ImperialCollegeLondon/PyProBE

Add fuzzy string matching to pyprobe.result.Result.get() method

Open
#304 1 comment 0 reactions 0 assignees View on GitHub
feature frontend good first issue
Dominant language
Python
Stars
56
Forks
20
PR merge metrics
No merged PRs in 30d

Description

The `pyprobe.result.Result.get()` method should support fuzzy string matching to enhance usability when querying for results with approximate or similar string keys. This feature will help users retrieve values even when there are minor typos or differences in the key strings, making the method more robust and user-friendly. Consider using a library like `fuzzywuzzy` or Python's `difflib` for the implementation. Include tests and documentation for the new fuzzy matching capability.

Example. `result.get("Voltage (V)")` should return a "did you mean `"Voltage [V]"`.

Contributor guide

Open the contributing guide

Research direction

Start with the pyprobe.result.Result.get() method and review how result keys are currently queried. Compare Python's difflib and fuzzywuzzy as possible approaches, then add tests and documentation covering approximate keys such as "Voltage (V)" matching "Voltage [V]"; done means the documented fuzzy lookup works and existing lookups remain covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.