add_name_attribute {primarycensored} | R Documentation |
Helper method for custom distributions
Description
pprimarycensored()
and related functions can identify which distributions
are provided via the pdist
and dprimary
arguments when those are base R
functions (e.g. punif
, dexp
) via the name
attribute.
Usage
add_name_attribute(func, name)
Arguments
func |
Function, for example the |
name |
Character string, starting with "p" or "d" indicating the underlying distribution. |
Details
If you need to use a non-base R implementation, but know the distribution
name, you can use this helper function to set it in a way that will be
detected by pprimarycensored()
and related functions.
This is useful as it enables the automatic use of analytical solutions for
distributions where they exist. You can check which analytical solutions are
available using methods(pcens_cdf)
and check distribution names using
pcd_dist_name()
.
Value
Function, with a "name" attribute added
See Also
Utility functions for working with distributions
pcd_dist_name()
,
pcd_distributions
,
pcd_primary_distributions
Examples
dist <- add_name_attribute(pnorm, "hello")
attr(dist, "name")