dot-format_class: Extract and Combine Distribution Names

.format_classR Documentation

Extract and Combine Distribution Names

Description

This helper function attempts to determine distribution names and uses those to establish a class name for potential analytical solutions.

Usage

.format_class(pdist, dprimary)

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 primary_dists.R 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.

Value

a character string representing the combined distribution class


primarycensored documentation built on April 3, 2025, 6:24 p.m.