https://github.com/ivelasq/wizehiver

R wrapper for WizeHive's Zengine API
https://github.com/ivelasq/wizehiver

api-wrapper r

Last synced: 1 day ago
JSON representation

R wrapper for WizeHive's Zengine API

• Host: GitHub
• URL: https://github.com/ivelasq/wizehiver
• Owner: ivelasq
• License: other
• Created: 2018-05-11T00:17:53.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2022-03-29T21:26:07.000Z (over 2 years ago)
• Last Synced: 2023-03-06T04:29:38.667Z (over 1 year ago)
• Topics: api-wrapper, r
• Language: R
• Homepage: https://ivelasq.github.io/wizehiver
• Size: 368 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r setup, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

#  wizehiver 

[![Codecov test coverage](https://codecov.io/gh/ivelasq/wizehiver/branch/master/graph/badge.svg)](https://codecov.io/gh/ivelasq/wizehiver?branch=master)

[![CRAN status](https://www.r-pkg.org/badges/version/wizehiver)](https://cran.r-project.org/package=wizehiver)

[![R-CMD-check](https://github.com/ivelasq/wizehiver/workflows/R-CMD-check/badge.svg)](https://github.com/ivelasq/wizehiver/actions)

[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

wizehiver is currently a **work in progress**.

The Zengine API, created by WizeHive, is a cloud-based platform that can organize the collection, review, and management of data and applications for grants and other business processes. The goal of wizehiver is to build functionality to:

1. Input and manage Zengine RESTful API tokens

2. Get available API resources

3. Process API response content into analysis-ready tibbles

The wizehiver package has no relationship or affiliation with, sponsorship, or endorsement by WizeHive.

## Installation

You can install the development version of wizehiver from [GitHub](https://github.com/) with:

``` r

# install.packages("devtools")

devtools::install_github("ivelasq/wizehiver")

```

## Setup

### Get and store the API key

Generate a Zengine API personal access token from your [Zengine account page](https://platform.zenginehq.com/account/developer).

wizehiver functions will read your Zengine API personal access token or key from the environment variable `ZENGINE_PAT` stored in `.Renviron`.

If `ZENGINE_PAT` is not stored in `.Renviron`, you will be prompted to edit it. You can also edit `.Renviron` by calling the function `set_token()` or `set_key()` directly.

To verify your access token or key is stored in `.Renviron`, use function `get_token()` or `get_key()`.

## Usage

### Get massive Zengine API JSON response

To obtain the Zengine API data, use `get_zen()`. Common choices include "forms" and "workspaces". A full list of resources is available [here](https://zenginehq.github.io/developers/rest-api/resources/).



  



---

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).

By participating in this project you agree to abide by its terms.