Skip to contents

Get Export Configuration Options

Source: R/help_plot.R
get_export_config.Rd

Returns documentation and default values for export configuration options used in plotting functions.

Usage

get_export_config(as_dataframe = TRUE, printing = FALSE)

Arguments

as_dataframe

Logical. Whether to return settings as a dataframe. Default is FALSE.

printing

Logical. If TRUE, prints a formatted code snippet that can be copied and pasted to recreate the configuration. Default is FALSE.

Value

If as_dataframe is TRUE, returns a dataframe with export configuration settings. Otherwise, returns a list with configuration settings.

Details

## **Export Configuration Parameters** - `file_name`: Character. Base name for exported files. Default: `"gtap_plots"` - `width`: Numeric or `NULL`. Plot width in inches. Default: `NULL` (automatically calculated) - `height`: Numeric or `NULL`. Plot height in inches. Default: `NULL` (automatically calculated) - `dpi`: Numeric. Resolution for PNG export. Default: `300` - `bg`: Character. Background color. Default: `"white"` - `limitsize`: Logical. Whether to limit size. Default: `FALSE`

See also

comparison_plot, detail_plot, stack_plot

Author

Pattawee Puangchit

Examples

# Get export configuration as list
export_info <- get_export_config()

# Get as a formatted dataframe
export_df <- get_export_config(as_dataframe = TRUE)