Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Included Pairwise Comparison Tool #1

Merged
merged 15 commits into from
Nov 21, 2024
Merged

Included Pairwise Comparison Tool #1

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
7f4ee05
Included comparison tool and an example with documentation.
Oct 18, 2024
a391d98
Added some comments, added data submodule, updated comparators and
Nov 13, 2024
a2b2ef8
Remove submodule from old path
Nov 13, 2024
9939276
Updated multiple files based on pr comments.
Nov 20, 2024
a70f226
Added pytests for fault injection and input validation.
Nov 20, 2024
cfd278b
Removed MIC module from tool due to lack of compatability.
Nov 20, 2024
6084d4e
Setup github actions for testing
MattsonCam Nov 19, 2024
9bf890e
Updated github actions workflow using pr comments.
Nov 20, 2024
a18b64c
Specified working directory for pytest testing with github actions.
Nov 20, 2024
923eba7
Updated README title name.
Nov 20, 2024
3c89582
Updated comment in testing code.
Nov 20, 2024
c784353
Merge branch 'main' into pairwise_compare_example
MattsonCam Nov 20, 2024
393d9f8
Removed submodule and updated the repo to use tracked NF1 data.
Nov 21, 2024
ff1e8f9
Removed print statement loop from test.
Nov 21, 2024
571fdc2
Added dataset for for running tests and examples.
Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
MattsonCam marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
# pairwise_compare
# pairwise_compare
This tool allows the user to compare instances (rows) of data specified in a tidy pandas dataframe with ease.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tool... made me wonder: is this a package? How might someone install it for use? Consider adding documentation to this effect.

MattsonCam marked this conversation as resolved.
Show resolved Hide resolved
MattsonCam marked this conversation as resolved.
Show resolved Hide resolved
In this repo the capabilities of the PairwiseCompareManger are shown through an example using the nuclear speckle data (`example_pairwise_comparisons.ipynb`).
MattsonCam marked this conversation as resolved.
Show resolved Hide resolved
MattsonCam marked this conversation as resolved.
Show resolved Hide resolved
Although, most of the development efforts can be found in the `utils` folder.

## Limitations
Some input validation has be enforced, although not exclusively.
For example, you should not specify the same column name in both the _same_columns list and _different_columns list.
MattsonCam marked this conversation as resolved.
Show resolved Hide resolved

## Extensibility
This tool is designed to compare feature between any two different rows within a tidy pandas dataframe.
MattsonCam marked this conversation as resolved.
Show resolved Hide resolved
To include additional comparisons, you will need to introduce the functionality as a class and inherit from the Comparator class.
MattsonCam marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider providing a link to the specific file that includes the Comparator class.

Loading