README.Rmd

---
output: github_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, eval = FALSE)
```
# streetlightR  
<!-- badges: start -->
[![R build status](https://github.com/Metropolitan-Council/streetlightR/workflows/R-CMD-check/badge.svg)](https://github.com/Metropolitan-Council/streetlightR/actions)
<!-- badges: end -->  

streetlightR is an R wrapper for [StreetLight Data's](https://www.streetlightdata.com/) InSight® API that makes it easier for users to create analyses, upload zone sets, fetch results, and more.  

To get a sense for what you can do with this package, see our [presentation](https://github.com/Metropolitan-Council/streetlightR/blob/main/inst/2022.11-StL-API.pdf) to the StreetLight API users group in November 2022.  

## Installation  

```{r}
remotes::install_github("Metropolitan-Council/streetlightR")
```

## StreetLight API  

StreetLight Data offers a limited-feature API for subscribers. Contact StreetLight [support](mailto:support@streetlightdata.com) to request an API key. Documentation is available at the [StreetLight Developer Hub](https://developer.streetlightdata.com/).

### API key management  

Contact StreetLight Data support to request an API key. Then, use `streetlight_api_key()` to save the key for future use. 
```{r}
library(streetlightR)
streetlight_api_key(key = "9999999", install = TRUE)
```

## Contributing  

We welcome contributions!

Please review our [CONTRIBUTING](.github/CONTRIBUTING.md) guide before making a contribution.

Thanks everyone who has contributed one way or another: 
[&#x0040;ehesch](https://github.com/ehesch), [&#x0040;ravenmcknight](https://github.com/ravenmcknight), and [&#x0040;eroten](https://github.com/eroten).

## Notes

This package is not affiliated with nor maintained by [StreetLight Data](https://www.streetlightdata.com/). This package is tool for StreetLight API users authored by StreetLight API users. 


<a href="https://metrocouncil.org" target="_blank"><img src="man/figures/main-logo.png" style="margin-left: 50%;margin-right: 50%;"><div></div></a>