ExportConfiguration | R Documentation |
R6 class defining properties for saving a ggplot
object
name
character defining the name of the file to be saved (without extension)
path
Path of the directory to save plot to: path and filename are combined to create the fully qualified file name. Defaults to the working directory.
format
character defining the format of the file to be saved
width
numeric values defining the width in units
of the plot dimensions after saving
height
numeric values defining the height in units
of the plot dimensions after saving
units
character defining the unit of the saving dimension
dpi
(dots per inch) numeric value defining plot resolution
new()
Create a new ExportConfiguration
object
ExportConfiguration$new( path = NULL, name = NULL, format = NULL, width = NULL, height = NULL, units = NULL, dpi = NULL )
path
Path of the directory to save plot to: path and filename are combined to create the fully qualified file name. Defaults to the working directory.
name
character defining the name of the file to be saved (without extension)
format
character defining the format of the file to be saved.
width
numeric values defining the width in units
of the plot dimensions after saving
height
numeric values defining the height in units
of the plot dimensions after saving
units
character defining the unit of the saving dimension
dpi
numeric value defining plot resolution (dots per inch)
A new ExportConfiguration
object
print()
Print properties of export configuration
ExportConfiguration$print()
Export configuration properties
getFileName()
Print the default exported file name from the export configuration
ExportConfiguration$getFileName()
Default file name
savePlot()
Save/Export a plot
ExportConfiguration$savePlot(plotObject, fileName = NULL)
plotObject
A ggplot
object
fileName
character file name of the exported plot
The file name of the exported plot
convertPixels()
If unit is in pixels, convert all export dimensions to inches to keep compatibility with older versions of ggplot2
ExportConfiguration$convertPixels()
clone()
The objects of this class are cloneable with this method.
ExportConfiguration$clone(deep = FALSE)
deep
Whether to make a deep clone.
Other PlotConfiguration classes:
AxisConfiguration
,
BackgroundConfiguration
,
BackgroundElement
,
BoxWhiskerPlotConfiguration
,
CumulativeTimeProfilePlotConfiguration
,
DDIRatioPlotConfiguration
,
HistogramPlotConfiguration
,
LabelConfiguration
,
LegendConfiguration
,
LineElement
,
ObsVsPredPlotConfiguration
,
PKRatioPlotConfiguration
,
PieChartPlotConfiguration
,
PlotConfiguration
,
PlotGridConfiguration
,
QQPlotConfiguration
,
ResVsPredPlotConfiguration
,
ResVsTimePlotConfiguration
,
TimeProfilePlotConfiguration
,
TornadoPlotConfiguration
,
XAxisConfiguration
,
YAxisConfiguration
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.