Format the name of a distribution

Format clean_name which is an item in the list returned from a call to a distribution, e.g., sdmTMB::delta_gamma()[["clean_name"]].

format_family(family, pretty = FALSE)

Arguments

family

A distribution from sdmTMB such as sdmTMB::delta_gamma().

pretty

A logical specifying if you want the returned value to be formatted for pretty printing, which is helpful when the text is going to be placed in a report on a figure.

Value

A string.

Author

Kelli F. Johnson

Examples

format_family(sdmTMB::delta_gamma())
#> [1] "delta_gamma"
format_family(sdmTMB::delta_gamma(), pretty = TRUE)
#> [1] "delta gamma"