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.

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

Create subcommand for getting demo data #279

Merged
merged 15 commits into from
Dec 10, 2024
Merged

Create subcommand for getting demo data #279

merged 15 commits into from
Dec 10, 2024

Conversation

naglepuff
Copy link
Collaborator

@naglepuff naglepuff commented Dec 2, 2024

Add Image DePHI demo.

Fix #190

Changes

1. New Subcommand

The new command imagedephi demo-data will parse the new file demo_files.csv and use pooch to download the files from DKC if you don't have that already.

2. Demo walkthrough

Instructions on using both the Image DePHI GUI and CLI are included under /docs. There's also a link from the README.

For Reviewers

Please make sure the new subcommand works and you can acquire the demo data. Also follow along with the walkthrough and provide feedback on clarity, coherence, etc.

@naglepuff naglepuff marked this pull request as ready for review December 4, 2024 20:28
@manthey
Copy link
Contributor

manthey commented Dec 10, 2024

@naglepuff This is excellent.

docs/demo.md Outdated
This will create a new directory in the location it is run called `demo_files` and download several whole slide images into that directory. These images contain fake PHI, which we will redact with Image DePHI.

## Redacting with the Graphical User Interface (GUI)
Image DePHI allows redaction of whole slide images through either a graphical user interface, accessible through a web browser, or a command line interface. First, let's take a look at the readaction workflow using the graphical user interface.
Copy link
Contributor

Choose a reason for hiding this comment

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

readaction -> redaction

docs/demo.md Outdated

## Getting the demo data

In order to get the demo data, you will need to have installed Image DePHI and run the following command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Elsewhere we use "ImageDePHI" as a single word. I think I prefer that to having the space between Image and DePHI.

hash = row["hash"]
algo, hash_value = hash.split(":")
pooch.retrieve(
url=f"http://data.kitware.com/api/v1/file/hashsum/{algo}/{hash_value}/download",
Copy link
Contributor

Choose a reason for hiding this comment

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

Change to https

@naglepuff naglepuff merged commit d50a495 into main Dec 10, 2024
4 checks passed
@naglepuff naglepuff deleted the 190-public-demo branch December 10, 2024 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make public demo and add to read me
2 participants