initialize_startr: Initialize startr project
In upstartr: Utilities Powering the Globe and Mail's Data Journalism Template

initialize_startr

R Documentation

Initialize startr project

Description

Used to initialize a startr template for analysis. Will enforce some startr-required standards for analysis (such as removing scientific notation, setting timezones, and writing some project configs to 'options').

Usage

initialize_startr(
  author = "Firstname Lastname <firstlast@example.com>",
  title = "startr",
  scipen = 999,
  timezone = "America/Toronto",
  should_render_notebook = FALSE,
  should_process_data = TRUE,
  should_timestamp_output_files = FALSE,
  should_clean_processing_variables = TRUE,
  should_beep = TRUE,
  set_minimal_graphics_theme = TRUE,
  packages = c()
)

Arguments

`author`	Name and email of the startr project author
`title`	Title of the startr project
`scipen`	Which level of scientific precision to use. (Default: 999)
`timezone`	The timezone for analysis. (Default: 'America/Toronto')
`should_render_notebook`	Whether the RMarkdown notebook should be rendered. (Default: FALSE)
`should_process_data`	Whether startr's process step should be run. (Default: TRUE)
`should_timestamp_output_files`	Whether write_excel's output files should be timestamped. (Default: FALSE)
`should_clean_processing_variables`	Whether processing variables should be cleaned from the environment after processing is complete. (Default: TRUE)
`should_beep`	Whether startr should beep after tasks like processing or knitting RMarkdown notebooks. (Default: TRUE)
`set_minimal_graphics_theme`	Whether the minimal graphics theme should be used. (Default: TRUE)
`packages`	Vector of package names, from CRAN, Github or Bioconductor to be installed. If using GitHub, package names should be in the format 'user/repo', e.g. 'globeandmail/upstartr'.