mean_table: Calculate and visualize the means of stratifying variables...

Description Usage Arguments Details Value See Also Examples

View source: R/population_table.R

Description

This function is designed to be run after using stratifier on the output that is produced. It produces a table of the population means and standard deviations of the stratification variables selected in each cluster. It also presents some visualizations of the population cluster information, which can help users describe the clusters.

Usage

1
mean_table(solution, plots = TRUE, store = FALSE)

Arguments

solution

object storing the output of stratifier; usually called generalizer_output

plots

defaults to TRUE; whether or not to create plots

store

defaults to FALSE; whether to export table and plots to files

Details

The function by default does not store this information, but users can save the plots manually, or specify the argument store to export the table and plots to files in their current working directory.

Value

a table of the mean values of selected stratifying variables across strata

See Also

http://thegeneralizer.org/, also add other resources

Examples

1
2
3
4
5
## Not run: 
# To view a table of means along with graphs:
mean_table(solution)

## End(Not run)

katiecoburn/thegeneralizer documentation built on July 6, 2020, 11:54 a.m.