R/startup.R

Defines functions startup

Documented in startup

#' A function that runs the reccomended functions before starting analysis.
#'
#' @description
#'   A function that runs the required functions before starting analysis.
#'   It downloads and loads the required packages
#'   It sets the working directory to the path of the source file
#'   It creates directories where you can drop files for analysis
#'   Prints "startup complete" when finished
#' @export
#' @return Returns TRUE if the startup was completed
#' @examples startup()
#'
startup <- function(){

  #load all required packages
  packages = c("ggplot2", "readr", "readxl", "writexl", "dplyr", "rstudioapi", "reshape2")

  install_load_packages(packages)

  #Set working directory to source directory
  setwd(dirname(rstudioapi::getActiveDocumentContext()$path))

  #Create directories that are frequently used
  create_directories()

  #return TRUE if the startup was completed succesfully
  print("startup complete")
  return(TRUE)
}
SamLoontjens/HandlingLicorFiles documentation built on Nov. 14, 2023, 6:32 a.m.