Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Complete setup. #1

Merged
merged 2 commits into from
Jul 28, 2023
Merged

Complete setup. #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e700af4
Complete setup.
jonthegeek Jul 28, 2023
6ddd4fb
Title case.
jonthegeek Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions DESCRIPTION
View file
Open in desktop
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", , "jonthegeek@gmail.com", 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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
test_that("Placeholder so tests pass.", {
succeed()
})