no_side_effect_warning: Stop execution if nothing is going to be returned or saved

Description Usage Arguments Value

View source: R/helper_functions.R

Description

Stop execution if nothing is going to be returned or saved

Usage

1

Arguments

plot

logical; should plot be returned in the current graphics device (likely in RStudio).

output_path

string; path where plot should be saved. Default is NULL. If path is provided, a PDF with the name "dendrogram_k_clusters" will be created, where k is the integer passed to cluster_number.

Value

If plot = FALSE and output_path = NULL, an error is returned. Otherwise, nothing is returned.


smmueller/plotdesignr documentation built on Jan. 5, 2022, 10:55 a.m.