From e4ffb2074695554ad378f2e9cc93b5b4587f1ee4 Mon Sep 17 00:00:00 2001 From: Andreas Bender Date: Sat, 27 Jan 2024 13:57:34 +0100 Subject: [PATCH 1/2] Fix documentation --- R/as-ped.R | 2 +- R/nest-utils.R | 2 -- R/tidyverse-methods.R | 3 --- 3 files changed, 1 insertion(+), 6 deletions(-) diff --git a/R/as-ped.R b/R/as-ped.R index d8cbf22b..dc9709ba 100644 --- a/R/as-ped.R +++ b/R/as-ped.R @@ -203,7 +203,7 @@ is.ped <- function(x) inherits(x, "ped") #' @rdname as_ped #' @param newdata A new data set (\code{data.frame}) that contains the same -#' variables that were used to create the PED object (code{data}). +#' variables that were used to create the PED object (\code{data}). #' @export as_ped.ped <- function(data, newdata, ...) { diff --git a/R/nest-utils.R b/R/nest-utils.R index b92cae63..f66603ce 100644 --- a/R/nest-utils.R +++ b/R/nest-utils.R @@ -22,8 +22,6 @@ nest_tdc <- function(data, formula, ...) { } #' @rdname nest_tdc -#' @param vars A character vector of TDCs that will be nested. -#' @param id A character giving the name of the ID column. #' @export nest_tdc.default <- function(data, formula, ...) { diff --git a/R/tidyverse-methods.R b/R/tidyverse-methods.R index ea664c57..2cbf674e 100644 --- a/R/tidyverse-methods.R +++ b/R/tidyverse-methods.R @@ -66,9 +66,7 @@ fped_attr <- function(fped) { #' @param .data an object of class \code{ped}, see \code{\link{as_ped}}. #' @param tbl an object of class \code{ped}, see \code{\link{as_ped}}. #' @param x an object of class \code{ped}, see \code{\link{as_ped}}. -#' @param funs see \code{\link[dplyr]{summarize_all}} #' @param ... see \code{dplyr} documentation -#' @param .dots see \code{dplyr} documentation #' @description See \code{dplyr} documentation of the respective functions for #' description and examples. #' @return a modified \code{ped} object (except for \code{do}) @@ -218,7 +216,6 @@ select.ped <- function(.data, ...) { } -#' @param keep_attributes conserve attributes? defaults to \code{TRUE} #' @export #' @export mutate #' @rdname dplyr_verbs From 137fd2dedc6229ee258766e33e7147925d7d5b75 Mon Sep 17 00:00:00 2001 From: Andreas Bender Date: Sat, 27 Jan 2024 14:04:50 +0100 Subject: [PATCH 2/2] updated Rd files --- man/as_ped.Rd | 2 +- man/dplyr_verbs.Rd | 6 ------ man/nest_tdc.Rd | 4 ---- 3 files changed, 1 insertion(+), 11 deletions(-) diff --git a/man/as_ped.Rd b/man/as_ped.Rd index c542bbbc..ab15a9cf 100644 --- a/man/as_ped.Rd +++ b/man/as_ped.Rd @@ -88,7 +88,7 @@ Often this will be \code{0}, which is the default.} \item{x}{any R object.} \item{newdata}{A new data set (\code{data.frame}) that contains the same -variables that were used to create the PED object (code{data}).} +variables that were used to create the PED object (\code{data}).} } \value{ A data frame class \code{ped} in piece-wise exponential data format. diff --git a/man/dplyr_verbs.Rd b/man/dplyr_verbs.Rd index ebb729fa..4d98021d 100644 --- a/man/dplyr_verbs.Rd +++ b/man/dplyr_verbs.Rd @@ -138,12 +138,6 @@ it is a potentially expensive operation so you must opt into it.} \item{suffix}{If there are non-joined duplicate variables in \code{x} and \code{y}, these suffixes will be added to the output to disambiguate them. Should be a character vector of length 2.} - -\item{funs}{see \code{\link[dplyr]{summarize_all}}} - -\item{.dots}{see \code{dplyr} documentation} - -\item{keep_attributes}{conserve attributes? defaults to \code{TRUE}} } \value{ a modified \code{ped} object (except for \code{do}) diff --git a/man/nest_tdc.Rd b/man/nest_tdc.Rd index e943d707..b3cebe41 100644 --- a/man/nest_tdc.Rd +++ b/man/nest_tdc.Rd @@ -22,10 +22,6 @@ Only TDCs present in \code{formula} will be returned.} part indicates the structure of the TDC structure.} \item{...}{Further arguments passed to methods.} - -\item{vars}{A character vector of TDCs that will be nested.} - -\item{id}{A character giving the name of the ID column.} } \description{ Provides methods to nest data with time-dependent covariates (TDCs).