generate_caption | R Documentation |
Generates a caption string based on provided attributes.
generate_caption(attributes)
attributes |
A list containing various attributes that may include
|
This function is useful for creating descriptive captions for plots or outputs based on the attributes provided. It ensures that only non-null attributes are included in the caption. This function constructs a caption string by checking various attributes provided in a list. It formats the caption based on the presence of specific attributes, such as dimensions, number of steps, and statistical parameters like mu and standard deviation (sd).
A character string representing the generated caption. If no attributes are provided, it returns an empty string.
Antti Lennart Rask
Other Utility Functions:
convert_snake_to_title_case()
,
get_attributes()
,
rand_walk_helper()
,
running_quantile()
,
std_cum_max_augment()
,
std_cum_mean_augment()
,
std_cum_min_augment()
,
std_cum_prod_augment()
,
std_cum_sum_augment()
attrs <- list(dimension = 3, num_steps = 100, mu = 0.5, sd = 1.2)
generate_caption(attrs) # "3 dimensions, 100 steps, mu = 0.5, sd = 1.2."
attrs <- list(dimension = NULL, num_steps = 50, mu = NULL, sd = 2.0)
generate_caption(attrs) # "50 steps, sd = 2.0."
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.