diff --git a/notebooks/curation_api/README.md b/notebooks/curation_api/README.md new file mode 100644 index 000000000..810511111 --- /dev/null +++ b/notebooks/curation_api/README.md @@ -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. + +## 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 +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. + +### R notebooks: `R/` + +These notebooks are the same as the "raw" Python notebooks mentioned immediately previous, but in R. diff --git a/notebooks/curation_api/R/create_collection_R.ipynb b/notebooks/curation_api/R_raw/create_collection_R.ipynb similarity index 100% rename from notebooks/curation_api/R/create_collection_R.ipynb rename to notebooks/curation_api/R_raw/create_collection_R.ipynb diff --git a/notebooks/curation_api/R/create_dataset_R.ipynb b/notebooks/curation_api/R_raw/create_dataset_R.ipynb similarity index 100% rename from notebooks/curation_api/R/create_dataset_R.ipynb rename to notebooks/curation_api/R_raw/create_dataset_R.ipynb diff --git a/notebooks/curation_api/R/create_revision_R.ipynb b/notebooks/curation_api/R_raw/create_revision_R.ipynb similarity index 100% rename from notebooks/curation_api/R/create_revision_R.ipynb rename to notebooks/curation_api/R_raw/create_revision_R.ipynb diff --git a/notebooks/curation_api/R/delete_collection_R.ipynb b/notebooks/curation_api/R_raw/delete_collection_R.ipynb similarity index 100% rename from notebooks/curation_api/R/delete_collection_R.ipynb rename to notebooks/curation_api/R_raw/delete_collection_R.ipynb diff --git a/notebooks/curation_api/R/delete_dataset_R.ipynb b/notebooks/curation_api/R_raw/delete_dataset_R.ipynb similarity index 100% rename from notebooks/curation_api/R/delete_dataset_R.ipynb rename to notebooks/curation_api/R_raw/delete_dataset_R.ipynb diff --git a/notebooks/curation_api/R/get_collection_R.ipynb b/notebooks/curation_api/R_raw/get_collection_R.ipynb similarity index 100% rename from notebooks/curation_api/R/get_collection_R.ipynb rename to notebooks/curation_api/R_raw/get_collection_R.ipynb diff --git a/notebooks/curation_api/R/get_collection_version_R.ipynb b/notebooks/curation_api/R_raw/get_collection_version_R.ipynb similarity index 100% rename from notebooks/curation_api/R/get_collection_version_R.ipynb rename to notebooks/curation_api/R_raw/get_collection_version_R.ipynb diff --git a/notebooks/curation_api/R/get_collection_versions_R.ipynb b/notebooks/curation_api/R_raw/get_collection_versions_R.ipynb similarity index 100% rename from notebooks/curation_api/R/get_collection_versions_R.ipynb rename to notebooks/curation_api/R_raw/get_collection_versions_R.ipynb diff --git a/notebooks/curation_api/R/get_collections_R.ipynb b/notebooks/curation_api/R_raw/get_collections_R.ipynb similarity index 100% rename from notebooks/curation_api/R/get_collections_R.ipynb rename to notebooks/curation_api/R_raw/get_collections_R.ipynb diff --git a/notebooks/curation_api/R/get_dataset_R.ipynb b/notebooks/curation_api/R_raw/get_dataset_R.ipynb similarity index 100% rename from notebooks/curation_api/R/get_dataset_R.ipynb rename to notebooks/curation_api/R_raw/get_dataset_R.ipynb diff --git a/notebooks/curation_api/R/get_dataset_version_R.ipynb b/notebooks/curation_api/R_raw/get_dataset_version_R.ipynb similarity index 100% rename from notebooks/curation_api/R/get_dataset_version_R.ipynb rename to notebooks/curation_api/R_raw/get_dataset_version_R.ipynb diff --git a/notebooks/curation_api/R/get_dataset_versions_R.ipynb b/notebooks/curation_api/R_raw/get_dataset_versions_R.ipynb similarity index 100% rename from notebooks/curation_api/R/get_dataset_versions_R.ipynb rename to notebooks/curation_api/R_raw/get_dataset_versions_R.ipynb diff --git a/notebooks/curation_api/R/get_datasets_R.ipynb b/notebooks/curation_api/R_raw/get_datasets_R.ipynb similarity index 100% rename from notebooks/curation_api/R/get_datasets_R.ipynb rename to notebooks/curation_api/R_raw/get_datasets_R.ipynb diff --git a/notebooks/curation_api/R/update_collection_R.ipynb b/notebooks/curation_api/R_raw/update_collection_R.ipynb similarity index 100% rename from notebooks/curation_api/R/update_collection_R.ipynb rename to notebooks/curation_api/R_raw/update_collection_R.ipynb diff --git a/notebooks/curation_api/R/upload_datafile_from_link_to_dataset_R.ipynb b/notebooks/curation_api/R_raw/upload_datafile_from_link_to_dataset_R.ipynb similarity index 100% rename from notebooks/curation_api/R/upload_datafile_from_link_to_dataset_R.ipynb rename to notebooks/curation_api/R_raw/upload_datafile_from_link_to_dataset_R.ipynb diff --git a/notebooks/curation_api/R/upload_local_datafile_to_dataset_R.ipynb b/notebooks/curation_api/R_raw/upload_local_datafile_to_dataset_R.ipynb similarity index 100% rename from notebooks/curation_api/R/upload_local_datafile_to_dataset_R.ipynb rename to notebooks/curation_api/R_raw/upload_local_datafile_to_dataset_R.ipynb