Skip to contents

Metadata

get_sample_info()
Get sample metadata by sample ID
get_project_info()
Get project metadata by project ID
get_project_samples()
Get a data frame of all samples in a given project
get_project_libraries()
Get metadata for all libraries in a given project
scpca_projects()
Get data frame of all ScPCA projects

Downloading data

Authentication

get_auth() view_terms()
Get an authorization token from the ScPCA API

File downloads

download_sample()
Download a sample's data files from the ScPCA Portal
download_project()
Download a project's data files from the ScPCA Portal

Custom datasets

create_dataset()
Create a custom dataset on the ScPCA Portal
get_dataset_status()
Get the processing status of a custom dataset
download_dataset()
Download a custom dataset's files from the ScPCA Portal
add_dataset_samples() remove_dataset_samples()
Add or remove samples and projects in a custom dataset
replace_dataset_data()
Replace the contents of an existing custom dataset
set_dataset_email()
Set the notification email for a custom dataset
start_dataset_processing()
Start processing a custom dataset
await_dataset_processing()
Wait for a custom dataset to finish processing