From e700af47222c8cad99ca6208280efd848daadf86 Mon Sep 17 00:00:00 2001 From: Jon Harmon Date: Fri, 28 Jul 2023 15:00:38 -0500 Subject: [PATCH 1/2] Complete setup. --- DESCRIPTION | 4 ++-- README.Rmd | 5 +++-- README.md | 10 +++++++--- rapid.Rproj | 5 +++++ tests/testthat/test-delete.R | 3 +++ 5 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 tests/testthat/test-delete.R diff --git a/DESCRIPTION b/DESCRIPTION index e2e7644..ab25253 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,8 +7,8 @@ Authors@R: 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) diff --git a/README.Rmd b/README.Rmd index 81bb7a3..a2b1846 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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) -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 @@ -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 diff --git a/README.md b/README.md index 09db721..14e0ba2 100644 --- a/README.md +++ b/README.md @@ -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) -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 @@ -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 diff --git a/rapid.Rproj b/rapid.Rproj index aaa62a5..69fafd4 100644 --- a/rapid.Rproj +++ b/rapid.Rproj @@ -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 diff --git a/tests/testthat/test-delete.R b/tests/testthat/test-delete.R new file mode 100644 index 0000000..87d6a72 --- /dev/null +++ b/tests/testthat/test-delete.R @@ -0,0 +1,3 @@ +test_that("Placeholder so tests pass.", { + succeed() +}) From 6ddd4fbde185343c9aef588e33f1ef144f787ffe Mon Sep 17 00:00:00 2001 From: Jon Harmon Date: Fri, 28 Jul 2023 15:04:47 -0500 Subject: [PATCH 2/2] Title case. --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index ab25253..50efcb3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,5 +1,5 @@ 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"),