R/add1s_y2.R

In nick-moffitt/y2artisan: Shortcuts for mschart and ggplot2

#### ***** MS CHARTS ***** ####
#### Add 1 Slide ####
### Description
#' Add 1 Blank PowerPoint slide
#'
#' This function adds a new PowerPoint slide. For this function to work, you need a powerpoint object saved into R called 'doc'
#' @param title DEFAULT: 'Title'; Add a slide title in quotes, automatically formatted to the Default Qualtrics template
#' @param commentary DEFAULT: 'Commentary'; Add commentary/desctiption in quotes, automatically formatted to the Default Qualtrics template
#' @param footer DEFAULT: 'Footer'; Add a footer in quotes
#' @param text_boxes DEFAULT = FALSE; Automatically adds title, commentary, and footer boxes to the blank slide. Set to F for no text boxes
#' @param slide_name DEFAULT: 'Findings / 1 chart'; The name of the type of the PP slide you want added to the PP
#' @param master_name DEFAULT: 'Office Theme'; The name of the PP master layout that the slide_name comes from
#' @param title_color DEFAULT: 'Black'; Color or hexcode for slide title
#' @param commentary_color DEFAULT: 'Black'; Color or hexcode for slide commentary
#' @param footer_color DEFAULT: 'Black'; Color or hexcode for slide footer
#' @param font_family DEFAULT: 'BentonSans Regular'; font for slide title, commentary, and footer
#' @keywords powerpoint slide
#' @export
#' @examples
#'
#' # Before adding slides, charts, or tables onto a powerpoint,
#' # you must first read a PowerPoint into R
#' \dontrun{
#' doc <- read_pptx('~/Y2 Analytics Dropbox/Y2 Analytics Team Folder/Projects/
#' Qualtrics/2021 Template and Resources/Template for mscharts.pptx')
#'
#' # Now start adding in your charts
#' doc <- add1s_y2()
#'
#' print(doc, '~/Desktop/test.pptx')
#' }


add1s_y2 <- function(
  title = 'Title',
  commentary = 'Commentary',
  footer = 'Footer',
  text_boxes = TRUE,
  slide_name = 'Blank',
  master_name = '1_Office Theme',
  title_color = 'Black',
  commentary_color = 'Black',
  footer_color = 'Black',
  font_family = 'BentonSans Regular'
) {
  doc <- officer::add_slide(
    doc,
    layout = slide_name,
    master = master_name
  )
  if (text_boxes == TRUE) {
    doc <- doc %>% add_title_findings(title, title_color, font_family)
    doc <- doc %>% add_commentary_findings(commentary, commentary_color, font_family)
    doc <- doc %>% add_footer_findings(footer, footer_color, font_family)
  } else {
    doc <- doc
  }
}


# Private functions -------------------------------------------------------

add_title_findings <- function(
  doc,
  text,
  title_color,
  font_family,
  font_size = 32,
  left = 0.5,
  top = 0.25,
  width = 10.5,
  height = .75
){
  properties <- officer::fp_text(
    color = title_color,
    font.size = font_size,
    font.family = font_family
  )

  slide_title <- officer::ftext(
    text,
    properties
  )

  officer::ph_with(
    doc,
    value = officer::fpar(slide_title),
    location = officer::ph_location(
      left = left,
      top = top,
      width = width,
      height = height
    )
  )
}


add_commentary_findings <- function(
  doc,
  text,
  commentary_color,
  font_family,
  font_size = 14,
  left = 0.5,
  top = 1,
  width = 10.5,
  height = .75
){
  properties <- officer::fp_text(
    color = commentary_color,
    font.size = font_size,
    font.family = font_family
  )

  slide_commentary <- officer::ftext(
    text,
    properties
  )

  officer::ph_with(
    doc,
    value = officer::fpar(slide_commentary),
    location = officer::ph_location(
      left = left,
      top = top,
      width = width,
      height = height
    )
  )
}


add_footer_findings <- function(
  doc,
  text,
  footer_color,
  font_family,
  font_size = 10,
  left = 0.5,
  top = 7,
  width = 10.5,
  height = .5
){
  properties <- officer::fp_text(
    color = footer_color,
    font.size = font_size,
    font.family = font_family
  )

  slide_footer <- officer::ftext(
    text,
    properties
  )

  officer::ph_with(
    doc,
    value = officer::fpar(slide_footer),
    location = officer::ph_location(
      left = left,
      top = top,
      width = width,
      height = height
    )
  )
}