R/init.R

In btskinner/rscorecard: A Method to Download Department of Education College Scorecard Data

#' Initialize chained request.
#'
#' This function initializes the data request. It should always be
#' the first in the series of piped functions.
#'
#' @param dfvars Set to \code{TRUE} if you would rather use the
#'     developer-friendly variable names used in actual API call.
#'
#' @examples
#' \dontrun{
#' sc_init()
#' sc_init(dfvars = TRUE)
#' }

#' @export
sc_init <- function(dfvars = FALSE) {

  list("sc_init_list" = TRUE,
       "dfvars" = dfvars,
       "select" = NULL,
       "select_order" = NULL,
       "filter" = NULL,
       "zip" = NULL,
       "year" = "latest")

}