-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
42 lines (30 loc) · 1.49 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# nectar <a href="https://nectar.api2r.org"><img src="man/figures/logo.svg" align="right" height="424" /></a>
<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/nectar)](https://CRAN.R-project.org/package=nectar)
[![Codecov test coverage](https://codecov.io/gh/jonthegeek/nectar/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jonthegeek/nectar?branch=main)
[![R-CMD-check](https://github.com/jonthegeek/nectar/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/nectar/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
An opinionated framework for use within api-wrapping R packages.
## Installation
You can install the development version of nectar from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("jonthegeek/nectar")
```
## Usage
Add usage information and examples here.
## Code of Conduct
Please note that the nectar project is released with a [Contributor Code of Conduct](https://nectar.api2r.org/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.