R/cas_options.R

In giocomai/castarter: Content Analysis Starter Toolkit

#' Set key project parameters that determine the folder used for storing project files
#'
#' Your project folder can be anywhwere on your file system. Considering that
#' this is where possibly a very large number of html files will be downloaded,
#' it is usually preferrable to choose a location that is not included in live
#' backups. These settings determine the names given to these hierarchical
#' folders: `website` folder will be under `project` folder which will be under
#' the `base_folder`.
#'
#' @param base_folder Defaults to NULL, can be set once per session with
#'   [cas_set_options()]. A path to a location used for storing html and other
#'   project files. If the folder does not exist, it will be created. If not
#'   given, and not previously set as environment variable, defaults to
#'   `castarter_data`.
#' @param db_folder Defaults to NULL. can be set once per session with
#'   [cas_set_options()] or [cas_set_db_folder()]. A path to a location used for
#'   storing the database. If not given, and not previously set as environment
#'   variable, defaults to `castarter_data`.
#' @param project Defaults to NULL. Project name, can be set once per session
#'   with [cas_set_options()]. This will be used as first level folder and may
#'   be used elsewhere to describe the dataset.
#' @param website Defaults to NULL. Website name, can be set once per session
#'   with [cas_set_options()]. This will be used as a second level folder and
#'   may be used elsewhere to describe the dataset.
#' @param use_db Defaults to TRUE. If TRUE, stores information about the
#'   download process and extracted text in a local database.
#'
#' @family settings
#'
#' @return Nothing, used for its side effects (setting options).
#' @export
#' @examples
#' cas_set_options(base_folder = fs::path(fs::path_temp(), "castarter_data"))
#' cas_options_list <- cas_get_options()
#' cas_options_list
cas_set_options <- function(project = NULL,
                            website = NULL,
                            use_db = TRUE,
                            base_folder = NULL,
                            db_type = "SQLite",
                            db_folder = NULL) {
  if (is.null(base_folder) == FALSE) {
    Sys.setenv(castarter_base_folder = base_folder)
  }

  if (is.null(db_folder) == FALSE) {
    Sys.setenv(castarter_database_folder = db_folder)
  }

  if (is.null(project) == FALSE) {
    Sys.setenv(castarter_project = project)
  }

  if (is.null(website) == FALSE) {
    Sys.setenv(castarter_website = website)
  }

  if (use_db == TRUE) {
    cas_enable_db(db_type = db_type)
  } else {
    cas_disable_db()
  }
}

#' Get key project parameters that determine the folder used for storing project files
#'
#' @family settings
#'
#' @return A list object with the given or previously set options.
#'
#' @inheritParams cas_set_options
#' @export
#'
#' @examples
#' # it is possible to set only a few options, and let others be added when calling functions
#' cas_set_options(base_folder = fs::path(fs::path_temp(), "castarter_data"))
#' cas_options_list <- cas_get_options()
#' cas_options_list
#'
#' cas_options_list2 <- cas_get_options(project = "test_project")
#' cas_options_list2
#'
#' cas_set_options(
#'   base_folder = fs::path(fs::path_temp(), "castarter_data"),
#'   project = "test_project",
#'   website = "test_website"
#' )
#'
#' cas_options_list3 <- cas_get_options()
#' cas_options_list3
#'
#' # Passing an argument overwrites the arguments set with options
#' cas_options_list4 <- cas_get_options(website = "test_website4")
#' cas_options_list4
#'
cas_get_options <- function(project = NULL,
                            website = NULL,
                            use_db = NULL,
                            base_folder = NULL,
                            db_type = NULL,
                            db_folder = NULL,
                            ...) {
  if (is.null(base_folder)) {
    base_folder <- Sys.getenv("castarter_base_folder")
    if (base_folder == "") {
      base_folder <- fs::path("castarter_data")
    }
  }


  if (is.null(project)) {
    project <- Sys.getenv("castarter_project")
  }

  if (is.null(website)) {
    website <- Sys.getenv("castarter_website")
  }

  if (is.null(db_type)) {
    db_type <- Sys.getenv("castarter_db_type")
    if (db_type == "") {
      db_type <- "SQLite"
    }
  }

  if (is.null(db_folder)) {
    db_folder <- Sys.getenv("castarter_database_folder")
    if (db_folder == "") {
      db_folder <- fs::path(
        base_folder,
        project,
        website
      )
    }
  }

  invisible(list(
    project = project,
    website = website,
    use_db = cas_check_use_db(use_db = use_db),
    base_folder = base_folder,
    db_type = db_type,
    db_folder = db_folder
  ))
}