S3 class for primary event censored distribution computation

Usage

new_pcens(
  pdist,
  dprimary,
  primary_args = NULL,
  pprimary = NULL,
  dprimary_args = NULL,
  ...
)

Arguments

pdist: Distribution function (CDF). The package can identify base R distributions for potential analytical solutions. For non-base R functions, users can apply add_name_attribute() to yield properly tagged functions if they wish to leverage the analytical solutions.
dprimary: Function to generate the probability density function (PDF) of primary event times. This function should take a value x and a pwindow parameter, and return a probability density. It should be normalized to integrate to 1 over [0, pwindow]. Defaults to a uniform distribution over [0, pwindow]. Users can provide custom functions or use helper functions like dexpgrowth for an exponential growth distribution. See pcd_primary_distributions() for examples. The package can identify base R distributions for potential analytical solutions. For non-base R functions, users can apply add_name_attribute() to yield properly tagged functions if they wish to leverage analytical solutions.
primary_args: List of additional arguments to be passed to dprimary (and the looked-up pprimary). Replaces the deprecated dprimary_args.
pprimary: CDF of the primary event distribution. May be a function or a character string naming a primary distribution in pcd_primary_distributions. When NULL (the default), it is looked up automatically from the registry using the "name" attribute of dprimary. When both dprimary and pprimary carry a name, the two must agree on everything other than the leading d/p prefix; mismatches such as dunif + pexpgrowth raise an error.
dprimary_args: [Deprecated] Use primary_args instead.
...: Additional arguments to be passed to pdist

Value

An object with class hierarchy c("pcens_{pdist_name}_{dprimary_name}", "pcens_{pdist_name}", "pcens"). This contains the primary event distribution, the delay distribution, the delay distribution arguments, the primary event CDF (if available), and any additional arguments. It can be used with the pcens_cdf() function to compute the primary event censored CDF.

Examples

new_pcens(
  pdist = pgamma, dprimary = dunif,
  primary_args = list(min = 0, max = 1),
  shape = 1, scale = 1
)
#> $pdist
#> function (q, shape, rate = 1, scale = 1/rate, lower.tail = TRUE, 
#>     log.p = FALSE) 
#> {
#>     if (!missing(rate) && !missing(scale)) {
#>         if (abs(rate * scale - 1) < 1e-15) 
#>             warning("specify 'rate' or 'scale' but not both")
#>         else stop("specify 'rate' or 'scale' but not both")
#>     }
#>     .Call(C_pgamma, q, shape, scale, lower.tail, log.p)
#> }
#> <bytecode: 0x560398d64a10>
#> <environment: namespace:stats>
#> 
#> $dprimary
#> function (x, min = 0, max = 1, log = FALSE) 
#> .Call(C_dunif, x, min, max, log)
#> <bytecode: 0x5603933744a8>
#> <environment: namespace:stats>
#> 
#> $primary_args
#> $primary_args$min
#> [1] 0
#> 
#> $primary_args$max
#> [1] 1
#> 
#> 
#> $dprimary_args
#> $dprimary_args$min
#> [1] 0
#> 
#> $dprimary_args$max
#> [1] 1
#> 
#> 
#> $pprimary
#> function (q, min = 0, max = 1, lower.tail = TRUE, log.p = FALSE) 
#> .Call(C_punif, q, min, max, lower.tail, log.p)
#> <bytecode: 0x560398c6edf8>
#> <environment: namespace:stats>
#> 
#> $args
#> $args$shape
#> [1] 1
#> 
#> $args$scale
#> [1] 1
#> 
#> 
#> attr(,"class")
#> [1] "pcens_pgamma_dunif" "pcens_pgamma"       "pcens"

S3 class for primary event censored distribution computation

Usage

Arguments

Value

See also

Examples