n_pages: Determine the number of pages in a paginated facet plot

Description Usage Arguments Value Examples

View source: R/facet_wrap_paginate.R

Description

This is a simple helper that returns the number of pages it takes to plot all panels when using facet_wrap_paginate() and facet_grid_paginate(). It partially builds the plot so depending on the complexity of your plot it might take some time to calculate...

Usage

1

Arguments

plot

A ggplot object using either facet_wrap_paginate or facet_grid_paginate

Value

If the plot uses using either facet_wrap_paginate or facet_grid_paginate it returns the total number of pages. Otherwise it returns NULL

Examples

1
2
3
4
p <- ggplot(diamonds) +
  geom_point(aes(carat, price), alpha = 0.1) +
  facet_wrap_paginate(~ cut:clarity, ncol = 3, nrow = 3, page = 1)
n_pages(p)

Example output

Loading required package: ggplot2
[1] 5

ggforce documentation built on March 5, 2021, 5:09 p.m.