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`).
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()
)
Name and email of the startr project author
Title of the startr project
Which level of scientific precision to use. (Default: 999)
The timezone for analysis. (Default: 'America/Toronto')
Whether the RMarkdown notebook should be rendered. (Default: FALSE)
Whether startr's process step should be run. (Default: TRUE)
Whether write_excel's output files should be timestamped. (Default: FALSE)
Whether processing variables should be cleaned from the environment after processing is complete. (Default: TRUE)
Whether startr should beep after tasks like processing or knitting RMarkdown notebooks. (Default: TRUE)
Whether the minimal graphics theme should be used. (Default: TRUE)
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'.
No return value, called for side effects