
<!-- README.md is generated from README.Rmd. Please edit that file -->

# CytobankAPI <img src="man/figures/logo.png" align="right" />

[![CRAN
version](https://CRAN.R-project.org/package=CytobankAPI)](https://CRAN.R-project.org/package=CytobankAPI)

## Overview

The `CytobankAPI` package is designed to make interacting with [Cytobank
API](https://support.cytobank.org/hc/en-us/articles/206336157-Overview-of-the-Cytobank-API)
endpoints easy via R. View the [Cytobank API Endpoint
Documentation](https://developer.cytobank.org/) for a comprehensive list
of API endpoints for Cytobank.

To find more general documentation on using the `CytobankAPI` package, view the following vignettes: 

- [Cytobank quickstart guide](https://cran.r-project.org/package=CytobankAPI/vignettes/cytobank-quickstart.html)
- [Cytobank advanced analysis guide](https://cran.r-project.org/package=CytobankAPI/vignettes/cytobank-advanced-analyses.html)

## Installation

``` r
# Install from CRAN
install.packages("CytobankAPI")
```
