Skip to content

Commit

Permalink
Complete setup. (#1)
Browse files Browse the repository at this point in the history
* Complete setup.

* Title case.
  • Loading branch information
jonthegeek authored Jul 28, 2023
1 parent 7bec67d commit c781a92
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 8 deletions.
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Package: rapid
Title: R 'API' documents
Title: R 'API' Documents
Version: 0.0.0.9000
Authors@R:
person("Jon", "Harmon", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-4781-4346"))
Description: Convert an 'API' document ('APID'), such as one that follows
the 'OpenAPI Specification', to an R object.
License: MIT + file LICENSE
URL: https://github.com/jonthegeek/rapid,
https://jonthegeek.github.io/rapid/
URL: https://jonthegeek.github.io/rapid/,
https://github.com/jonthegeek/rapid
BugReports: https://github.com/jonthegeek/rapid/issues
Suggests:
testthat (>= 3.0.0)
Expand Down
5 changes: 3 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ knitr::opts_chunk$set(
[![R-CMD-check](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

Convert an 'API' document ('APID'), such as one that follows the 'OpenAPI Specification', to an R object.
Convert an API document (APID), such as one that follows the [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.0), to an R object.
The R object enforces is a new S3 class, "apid", which enforces a strict, opinionated schema.

## Installation

Expand All @@ -35,7 +36,7 @@ remotes::install_github("jonthegeek/rapid")

## Usage

Add usage information and examples here.
This package will be used by [{beekeeper}](https://jonthegeek.github.io/beekeeper/) and [{mockplumber}](https://jonthegeek.github.io/mockplumber/).

## Code of Conduct

Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ coverage](https://codecov.io/gh/jonthegeek/rapid/branch/main/graph/badge.svg)](h
[![R-CMD-check](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

Convert an ‘API’ document (‘APID’), such as one that follows the
‘OpenAPI Specification’, to an R object.
Convert an API document (APID), such as one that follows the [OpenAPI
Specification](https://spec.openapis.org/oas/v3.0.0), to an R object.
The R object enforces is a new S3 class, “apid”, which enforces a
strict, opinionated schema.

## Installation

Expand All @@ -29,7 +31,9 @@ remotes::install_github("jonthegeek/rapid")

## Usage

Add usage information and examples here.
This package will be used by
[{beekeeper}](https://jonthegeek.github.io/beekeeper/) and
[{mockplumber}](https://jonthegeek.github.io/mockplumber/).

## Code of Conduct

Expand Down
5 changes: 5 additions & 0 deletions rapid.Rproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@ SaveWorkspace: No
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX

AutoAppendNewline: Yes
StripTrailingWhitespace: Yes
LineEndingConversion: Posix
Expand Down
3 changes: 3 additions & 0 deletions tests/testthat/test-delete.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
test_that("Placeholder so tests pass.", {
succeed()
})

0 comments on commit c781a92

Please sign in to comment.