summaryrefslogtreecommitdiff
path: root/R/saveplot.R
blob: 8c5677ca0b9435beb565145bb037b084634c1659 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#' Save a ggplot object
#'
#' Standard method for saving ggplot objects for best
#' quality for the desired use case
#'
#' @param p ggplot object you want to save
#' @param filename The name of the file you want to export to
#' @param units The units for dimensions of the plot (default inches)
#' @param width Width of the plot in units (default 10)
#' @param height Height of the plot in units (default 10)
#' @param dpi Dots per inch (detault 300)
#'
#' @return No return value
#'
#' @examples
#' df <- data.frame(x = rnorm(100))
#' p <- ggplot2::ggplot(data = df, ggplot2::aes(x = x)) + ggplot2::geom_histogram()
#' saveplot(p, filename = 'plot.png')
#'
#' @import ggplot2
#' @import ragg
#' @export
saveplot <- function(
	p,
	filename,
	units = 'in',
	width = 10,
	height = 10,
	dpi = 600
){
	ggplot2::ggsave(
		filename = filename,
		plot = p,
		width = width,
		height = height,
		units = units,
		dpi = dpi,
		device = ragg::agg_png
	)
}