change .plot_indicator_correlations to .plot_correlations and adjust …

…documentation

R/plot.cSEMResult.R

@@ -20,7 +20,7 @@ plot.cSEMResults_default <- function(
     x = NULL, 
     .title = args_default()$.title,
     .plot_significances = args_default()$.plot_significances, 
-    .plot_indicator_correlations = args_default()$.plot_indicator_correlations,
+    .plot_correlations = args_default()$.plot_correlations,
     .plot_structural_model_only = args_default()$.plot_structural_model_only,
     .graph_attrs = args_default()$.graph_attrs,
     ...
@@ -64,7 +64,7 @@ plot.cSEMResults_default <- function(
                            path_p_values = path_p_values,
                            correlations = correlations,
                            plot_significances = .plot_significances,
-                           plot_indicator_correlations = .plot_indicator_correlations,
+                           plot_indicator_correlations = .plot_correlations,
                            plot_structural_model_only = .plot_structural_model_only,
                            is_second_order = FALSE)
 
@@ -95,7 +95,7 @@ plot.cSEMResults_multi <- function(
     x = NULL, 
     .title =  args_default()$.title,
     .plot_significances = args_default()$.plot_significances, 
-    .plot_indicator_correlations = args_default()$.plot_indicator_correlations,
+    .plot_correlations = args_default()$.plot_correlations,
     .plot_structural_model_only = args_default()$.plot_structural_model_only,
     .graph_attrs = args_default()$.graph_attrs,
     ...
@@ -105,7 +105,7 @@ plot.cSEMResults_multi <- function(
     plot(group_object,
               .title = group_title,
               .plot_significances = .plot_significances,
-              .plot_indicator_correlations = .plot_indicator_correlations,
+              .plot_correlations = .plot_correlations,
               .plot_structural_model_only = .plot_structural_model_only,
               .graph_attrs = .graph_attrs)
   }, names(x), x)
@@ -134,7 +134,7 @@ plot.cSEMResults_2ndorder <- function(
     x,
     .title = args_default()$.title,
     .plot_significances = args_default()$.plot_significances,
-    .plot_indicator_correlations = args_default()$.plot_indicator_correlations,
+    .plot_correlations = args_default()$.plot_correlations,
     .plot_structural_model_only = args_default()$.plot_structural_model_only,
     .graph_attrs = args_default()$.graph_attrs,
     ...
@@ -258,7 +258,7 @@ plot.cSEMResults_2ndorder <- function(
                            path_p_values = combined_path_p,
                            correlations = correlations,
                            plot_significances = .plot_significances,
-                           plot_indicator_correlations = .plot_indicator_correlations,
+                           plot_indicator_correlations = .plot_correlations,
                            plot_structural_model_only = .plot_structural_model_only,
                            is_second_order = TRUE)
 

R/zz_arguments.R

@@ -224,8 +224,8 @@
 #'   "*fisher_transformed*", "*mean_arithmetic*", "*mean_geometric*", "*mean_harmonic*",
 #'   "*geo_of_harmonic*". Defaults to "*dist_squared_euclid*". 
 #'   Ignored if `.disattenuate = FALSE` or if `.approach_weights` is not PLS-PM.
-#' @param .plot_indicator_correlations Logical. Should the correlations between the exogenous constructs
-#'   or indicators be plotted? Defaults to `exo`.
+#' @param .plot_correlations Character string. Specify which correlations should be plotted, i.e., 
+#'  between the exogenous constructs (`exo`), between the exogenous constructs and between the indicators (`both`), or not at all (`none`)? Defaults to `exo`.
 #' @param .plot_package Character string. Indicates which packages should be used for plotting.
 #' @param .plot_significances Logical. Should p-values in the form of stars be plotted? Defaults to `TRUE`.
 #' @param .plot_structural_model_only Logical. Should only the structural model, 
@@ -520,7 +520,7 @@ args_default <- function(.choices = FALSE) {
     .parameters_to_compare   = NULL,
     .path                    = NULL,
     .path_coefficients       = NULL,
-    .plot_indicator_correlations = c("exo", "both", "none"),
+    .plot_correlations = c("exo", "both", "none"),
     .plot_package            = NULL,
     .plot_significances      = TRUE,
     .plot_structural_model_only = FALSE,