R/getPaths.R

Defines functions getPaths

Documented in getPaths

#' Helper function to return all paths
#'
#'@return all valid paths
#'
#' @author Layla Rohkohl, \email{byehity@gmail.com}
#'
#' @examples
#' getPaths()
#'
#' @export
#'
# Helper function to view all paths possible
getPaths <- function(pretty_print = TRUE) {
  # Paths as list
  paths <- c("organizations",
 "people",
"funding_rounds",
 "acquisitions",
"investments",
 "events",
"press_references",
"funds",
"event_appearances",
"ipos",
"ownerships",
"categories",
 "category_groups",
 "locations",
"jobs",
 "addresses",
"degrees")

  # Print out
  if (pretty_print) {
    cat("Here are the available paths:\n")
    return(paths)
  } else {
    return(paths)
  }
}
Lyrohk/cruncher documentation built on Dec. 17, 2021, 1:17 a.m.