generate_output: Generate Interpretable Output from a CCAS object.

Description Usage Arguments Value Examples

View source: R/generate_output.R

Description

Generates a large number of plots of various posterior quantites of interest, including trace plots, parameter estimates, and top words. Note that if the user wishes to generate network plots with nodes colored by some categorical variable, they will need to call the plot_interaction_pattern_network() function separately.

Usage

1
2
generate_output(CCAS_Object, output_directory = NULL,
  output_name_stem = NULL, generate_plots = TRUE)

Arguments

CCAS_Object

The object returned by the ccas() main estimation function.

output_directory

The directory where the user would like to save plots if an output_name_stem is given. Defaults to NULL, in which case the current working directory will be used.

output_name_stem

Defaults to NULL. If not null, then output will be saved to disk using the output_name_stem to differentiate it from output from other model runs.

generate_plots

Logical indicating whether plots should be generated, defaults to TRUE, but may be set to FALSE if the user only wishes to access aggregate data.

Value

A series of plots and a CCAS_Object containing useful output.

Examples

1
2
3
4
5
6
7
8
## Not run: 
# load in saved model output from ccas() function.
data(Model_Output)
summary_output <- generate_output(Model_Output,
                                  output_directory = "~/Desktop",
                                  output_name_stem = "Testing")

## End(Not run)

matthewjdenny/CCAS documentation built on May 21, 2019, 1:01 p.m.