diff --git a/DESCRIPTION b/DESCRIPTION index 45ff7f16..2ce31199 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Encoding: UTF-8 Package: plumber Type: Package Title: An API Generator for R -Version: 1.2.2 +Version: 1.2.2.9000 Roxygen: list(markdown = TRUE) Authors@R: c( person("Barret", "Schloerke", role = c("cre", "aut"), email = "barret@posit.co", comment = c(ORCID = "0000-0001-9986-114X")), @@ -31,7 +31,7 @@ Imports: swagger (>= 3.33.0), magrittr, mime, - lifecycle (>= 0.2.0), + lifecycle (>= 1.0.0), rlang (>= 1.0.0) ByteCompile: TRUE Suggests: @@ -92,7 +92,6 @@ Collate: 'utils.R' 'validate_api_spec.R' 'zzz.R' -RdMacros: lifecycle Language: en-US Config/Needs/check: Cairo Config/Needs/website: tidyverse/tidytemplate diff --git a/NEWS.md b/NEWS.md index 82e64035..eae12fb1 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,5 @@ +# plumber (development version) + # plumber 1.2.2 * Allow to set plumber options using environment variables `?options_plumber`. (@meztez #934) diff --git a/R/serializer.R b/R/serializer.R index 0f14a408..bd778ec5 100644 --- a/R/serializer.R +++ b/R/serializer.R @@ -436,7 +436,7 @@ serializer_xml <- function() { #' Endpoint Serializer with Hooks #' -#' This method allows serializers to return `preexec`, `postexec`, and `aroundexec` (\lifecycle{experimental}) hooks in addition to a serializer. +#' This method allows serializers to return `preexec`, `postexec`, and `aroundexec` (`r lifecycle::badge("experimental")`) hooks in addition to a serializer. #' This is useful for graphics device serializers which need a `preexec` and `postexec` hook to capture the graphics output. #' #' `preexec` and `postexec` hooks happened directly before and after a route is executed. @@ -445,7 +445,7 @@ serializer_xml <- function() { #' @param serializer Serializer method to be used. This method should already have its initialization arguments applied. #' @param preexec_hook Function to be run directly before a [PlumberEndpoint] calls its route method. #' @param postexec_hook Function to be run directly after a [PlumberEndpoint] calls its route method. -#' @param aroundexec_hook Function to be run around a [PlumberEndpoint] call. Must handle a `.next` argument to continue execution. \lifecycle{experimental} +#' @param aroundexec_hook Function to be run around a [PlumberEndpoint] call. Must handle a `.next` argument to continue execution. `r lifecycle::badge("experimental")` #' #' @export #' @examples diff --git a/R/validate_api_spec.R b/R/validate_api_spec.R index 25198e43..788b4c1e 100644 --- a/R/validate_api_spec.R +++ b/R/validate_api_spec.R @@ -49,7 +49,7 @@ validate_api_spec__install_node_modules <- function() { #' #' If the api is deemed invalid, an error will be thrown. #' -#' This function is VERY \lifecycle{experimental} and may be altered, changed, or removed in the future. +#' This function is VERY `r lifecycle::badge("experimental")` and may be altered, changed, or removed in the future. #' #' @param pr A Plumber API #' @param verbose Logical that determines if a "is valid" statement is displayed. Defaults to `TRUE` diff --git a/README.md b/README.md index 2a21d086..912f0adb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![R build status](https://github.com/rstudio/plumber/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rstudio/plumber/actions) -[![](https://www.r-pkg.org/badges/version/plumber)](https://www.r-pkg.org/pkg/plumber) +[![CRAN version](https://www.r-pkg.org/badges/version/plumber)](https://www.r-pkg.org/pkg/plumber) [![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/plumber?color=brightgreen)](https://www.r-pkg.org/pkg/plumber) [![codecov](https://app.codecov.io/gh/rstudio/plumber/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rstudio/plumber) [![RStudio community](https://img.shields.io/badge/community-plumber-blue?style=social&logo=rstudio&logoColor=75AADB)](https://forum.posit.co/tag/plumber) @@ -97,7 +97,7 @@ library(plumber) ## Cheat Sheet - +plumber cheat sheet ## Hosting @@ -110,12 +110,12 @@ custom API in just two R commands. To deploy to DigitalOcean, check out the [Posit Connect](https://posit.co/products/enterprise/connect/) is a commercial publishing platform that enables R developers to easily publish a variety of R content types, including Plumber APIs. Additional documentation is available at -https://www.rplumber.io/articles/hosting.html#rstudio-connect-1. +. A couple of other approaches to hosting plumber are also made available: - - PM2 - https://www.rplumber.io/articles/hosting.html#pm2-1 - - Docker - https://www.rplumber.io/articles/hosting.html#docker +- PM2 - +- Docker - ## Related Projects diff --git a/man/endpoint_serializer.Rd b/man/endpoint_serializer.Rd index 66a4a041..2ee1ed1b 100644 --- a/man/endpoint_serializer.Rd +++ b/man/endpoint_serializer.Rd @@ -18,10 +18,10 @@ endpoint_serializer( \item{postexec_hook}{Function to be run directly after a \link{PlumberEndpoint} calls its route method.} -\item{aroundexec_hook}{Function to be run around a \link{PlumberEndpoint} call. Must handle a \code{.next} argument to continue execution. \lifecycle{experimental}} +\item{aroundexec_hook}{Function to be run around a \link{PlumberEndpoint} call. Must handle a \code{.next} argument to continue execution. \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}} } \description{ -This method allows serializers to return \code{preexec}, \code{postexec}, and \code{aroundexec} (\lifecycle{experimental}) hooks in addition to a serializer. +This method allows serializers to return \code{preexec}, \code{postexec}, and \code{aroundexec} (\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}) hooks in addition to a serializer. This is useful for graphics device serializers which need a \code{preexec} and \code{postexec} hook to capture the graphics output. } \details{ diff --git a/man/validate_api_spec.Rd b/man/validate_api_spec.Rd index 0890c5df..669d7daa 100644 --- a/man/validate_api_spec.Rd +++ b/man/validate_api_spec.Rd @@ -17,7 +17,7 @@ Validate an OpenAPI Spec using \href{https://github.com/APIDevTools/swagger-cli} \details{ If the api is deemed invalid, an error will be thrown. -This function is VERY \lifecycle{experimental} and may be altered, changed, or removed in the future. +This function is VERY \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} and may be altered, changed, or removed in the future. } \examples{ \dontrun{