From ac077b086c43c294d80a538edb7e01ea04c60ee6 Mon Sep 17 00:00:00 2001 From: Alexandre Courtiol Date: Sat, 28 Oct 2023 17:30:58 +0200 Subject: [PATCH] Add value field in documentation --- DESCRIPTION | 2 +- NEWS.md | 4 ++++ R/lay.R | 2 ++ man/lay.Rd | 3 +++ 4 files changed, 10 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index d7560a2..b4e7559 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: lay Title: Simple but Efficient Rowwise Jobs -Version: 0.1.2 +Version: 0.1.3 Authors@R: c( person("Alexandre", "Courtiol", email = "alexandre.courtiol@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-0637-2959")), person("Romain", "François", role = c("aut"), comment = c(ORCID = "0000-0002-2444-4226")) diff --git a/NEWS.md b/NEWS.md index 801f3c0..72f47ca 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# lay 0.1.3 + +* Add value field in documentation to meet CRAN requirements. + # lay 0.1.2 * Initial CRAN submission. diff --git a/R/lay.R b/R/lay.R index b183458..d157be4 100644 --- a/R/lay.R +++ b/R/lay.R @@ -51,6 +51,8 @@ #' #' The default has been chosen based on these [**benchmarks**](https://courtiol.github.io/lay/articles/benchmarks.html). #' +#' @return A vector with one element per row of `.data`, or a data frame (or tibble) with one row per row of `.data`. The class of the output is determined by `.fn`. +#' #' @importFrom vctrs vec_c #' @importFrom rlang list2 exec as_function #' @importFrom purrr pmap diff --git a/man/lay.Rd b/man/lay.Rd index d8ca7ae..506dcbf 100644 --- a/man/lay.Rd +++ b/man/lay.Rd @@ -33,6 +33,9 @@ across columns. The default has been chosen based on these \href{https://courtiol.github.io/lay/articles/benchmarks.html}{\strong{benchmarks}}.} } +\value{ +A vector with one element per row of \code{.data}, or a data frame (or tibble) with one row per row of \code{.data}. The class of the output is determined by \code{.fn}. +} \description{ Create efficiently new column(s) in data frame (including tibble) by applying a function one row at a time.