From 63bdc1da6428e1c248445427c865cf963c1c1fb4 Mon Sep 17 00:00:00 2001 From: "Logan C. Brooks" Date: Thu, 24 Oct 2024 15:53:37 -0700 Subject: [PATCH 1/2] docs(complete.epi_df): fix backticks, tweak 1-line summary --- R/methods-epi_df.R | 4 ++-- man/complete.epi_df.Rd | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/R/methods-epi_df.R b/R/methods-epi_df.R index 84a75e46..ffbfa9c5 100644 --- a/R/methods-epi_df.R +++ b/R/methods-epi_df.R @@ -256,9 +256,9 @@ group_modify.epi_df <- function(.data, .f, ..., .keep = FALSE) { dplyr::dplyr_reconstruct(NextMethod(), .data) } -#' Complete epi_df +#' Complete an `epi_df` with additional rows for missing key combinations #' -#' A `tidyr::complete()` analogue for `epi_df`` objects. This function +#' A `tidyr::complete()` analogue for `epi_df` objects. This function #' can be used, for example, to add rows for missing combinations #' of `geo_value` and `time_value`, filling other columns with `NA`s. #' See the examples for usage details. diff --git a/man/complete.epi_df.Rd b/man/complete.epi_df.Rd index 71dbcb38..02323a5c 100644 --- a/man/complete.epi_df.Rd +++ b/man/complete.epi_df.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/methods-epi_df.R \name{complete.epi_df} \alias{complete.epi_df} -\title{Complete epi_df} +\title{Complete an \code{epi_df} with additional rows for missing key combinations} \usage{ \method{complete}{epi_df}(data, ..., fill = list(), explicit = TRUE) } @@ -16,7 +16,9 @@ \item{explicit}{see \code{\link[tidyr:complete]{tidyr::complete}}} } \description{ -A \code{tidyr::complete()} analogue for \verb{epi_df`` objects. This function can be used, for example, to add rows for missing combinations of }geo_value\code{and}time_value\verb{, filling other columns with }NA`s. +A \code{tidyr::complete()} analogue for \code{epi_df} objects. This function +can be used, for example, to add rows for missing combinations +of \code{geo_value} and \code{time_value}, filling other columns with \code{NA}s. See the examples for usage details. } \examples{ From c3be3acc34f69c55465b2d272dc49b2a9af5d5c3 Mon Sep 17 00:00:00 2001 From: "Logan C. Brooks" Date: Fri, 25 Oct 2024 11:19:18 -0700 Subject: [PATCH 2/2] docs(complete.epi_df): further tweak summary line --- R/methods-epi_df.R | 2 +- man/complete.epi_df.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/methods-epi_df.R b/R/methods-epi_df.R index ffbfa9c5..6e19f753 100644 --- a/R/methods-epi_df.R +++ b/R/methods-epi_df.R @@ -256,7 +256,7 @@ group_modify.epi_df <- function(.data, .f, ..., .keep = FALSE) { dplyr::dplyr_reconstruct(NextMethod(), .data) } -#' Complete an `epi_df` with additional rows for missing key combinations +#' "Complete" an `epi_df`, adding missing rows and/or replacing `NA`s #' #' A `tidyr::complete()` analogue for `epi_df` objects. This function #' can be used, for example, to add rows for missing combinations diff --git a/man/complete.epi_df.Rd b/man/complete.epi_df.Rd index 02323a5c..38c9a6fe 100644 --- a/man/complete.epi_df.Rd +++ b/man/complete.epi_df.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/methods-epi_df.R \name{complete.epi_df} \alias{complete.epi_df} -\title{Complete an \code{epi_df} with additional rows for missing key combinations} +\title{"Complete" an \code{epi_df}, adding missing rows and/or replacing \code{NA}s} \usage{ \method{complete}{epi_df}(data, ..., fill = list(), explicit = TRUE) }