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

docs: add README for Curation API notebooks #620

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions notebooks/curation_api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Discover API notebooks

These notebooks facilitate use of the [Discover API](https://api.cellxgene.cziscience.com/curation/ui/#/) which enables
data consumers to query for public collections and datasets available in
[CZ CELLxGENE Discover](https://cellxgene.cziscience.com/) and to download individual datasets.

danieljhegeman marked this conversation as resolved.
Show resolved Hide resolved
## Notebook usage

Many notebooks have a few fields that require user input, such as the relevant Collection id or Dataset id.

### Python notebooks: `python/`

These notebooks are the most user-friendly; start here if you're unsure. All access token generation, url construction, and response
Copy link
Contributor

Choose a reason for hiding this comment

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

access token generation is confusing for non-curation use which does not require access tokens?

handling is abstracted away from the user. Unitary interactions such as getting a Dataset, getting a Collection, etc.,
are each handled by single function calls.

### "Raw" Python notebooks: `python_raw/`

These notebooks show the construction of http requests at a more granular level and may be useful for technical
users.

Copy link
Contributor

Choose a reason for hiding this comment

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

and as such may be useful for technical users.

This might be useful for someone who wants to port the REST API to another language or wants more control of the responses?

Copy link
Author

Choose a reason for hiding this comment

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

or wants more control over the request, yes (for us, at the moment, and partners, in the case of hitting a Discover API on rdev...)

Copy link
Author

Choose a reason for hiding this comment

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

changed to only reference consumer actions...

### R notebooks: `R/`

These notebooks are the same as the "raw" Python notebooks mentioned immediately previous, but in R.
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems like this directory should be named R_raw to be symmetrical?

Copy link
Author

Choose a reason for hiding this comment

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

Renamed (see diff below)

Copy link
Author

Choose a reason for hiding this comment

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

I can also move the entire notebooks/curation_api/ dir to notebooks/discover_api/ in a follow-up PR...

Loading