Merge pull request #4 from globeandmail/write_plot_fix

Fixes issues with write_plot and initialize_startr

Author: tomcardoso

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: upstartr
 Type: Package
 Title: Utilities Powering the Globe and Mail's Data Journalism Template
-Version: 0.1.0
+Version: 0.1.1
 Authors@R:
     c(person(given = "Tom",
              family = "Cardoso",

NEWS.md

@@ -1,3 +1,10 @@
+Version 0.1.1
+====================
+
+Small bug fixes:
+- Adds an extra newline to the `initialize_startr()` log messages so that it stays on its own line.
+- Fixes an issue with `write_plot()` where the `format` parameter was inadvertently being passed to `ggsave()`, which would then throw an error.
+
 Version 0.1.0
 ====================
 

R/init.R

@@ -91,5 +91,5 @@ initialize_startr <- function(
       root.dir = here::here()
     )
 
-    cat(crayon::green(glue::glue('{bquote("\u2713")} Your startr project \'{crayon::bold(title)}\' has been initialized!\n')))
+    cat(crayon::green(glue::glue('{bquote("\u2713")} Your startr project {crayon::bold(title)} has been initialized!\n\n')))
 }

R/write.R

@@ -33,24 +33,22 @@ write_excel <- function(variable, output_dir = dir_data_out(), should_timestamp_
 #' variable name as the filename.
 #'
 #' @param variable A tibble or dataframe object.
+#' @param format The desired format for the plot, be it 'png', 'pdf', etc. Accepts formats
+#'   you'd pass to \code{ggplot2::\link[ggplot2:ggsave]{ggsave}}'s 'device' parameter.
 #' @param output_dir The directory to save the plot out to.
 #' @param ... Other settings to pass to ggsave, such as format, width, height or dpi.
 #'
 #' @return No return value, called for side effects
 #'
 #' @export
-write_plot <- function(variable, output_dir = dir_plots(), ...) {
+write_plot <- function(variable, format = 'png', output_dir = dir_plots(), ...) {
   filename <- deparse(substitute(variable))
 
   args <- list(plot = variable, ...)
 
-  if (is.null(args[['format']])) {
-    args[['format']] <- 'png'
-  }
-
-  args[['file']] <- here::here(output_dir, glue::glue("{filename}.{args[['format']]}"))
+  args[['file']] <- here::here(output_dir, glue::glue("{filename}.{format}"))
 
-  if (args[['format']] == 'pdf') args[['useDingbats']] <- FALSE
+  if ('format' == 'pdf') args[['useDingbats']] <- FALSE
 
   do.call(ggplot2::ggsave, args)
 }

cran-comments.md

@@ -8,4 +8,6 @@
 There were no ERRORs, WARNINGs or NOTEs.
 
 ## Change notes
-As requested by reviewer, adds `@return` for `reorder_within`, `scale_x_reordered` and `scale_y_reordered` functions. In DESCRIPTION, added The Globe and Mail Inc. as a copyright holder, and Michael Pereira as a contributor given his work on the main [`startr`](https://github.com/globeandmail/startr) package, which this project was born out of.
+Two small bug fixes:
+- Adds an extra newline to the `initialize_startr()` log messages so that it stays on its own line.
+- Fixes an issue with `write_plot()` where the `format` parameter was inadvertently being passed to `ggsave()`, which would then throw an error.