R/CCG_boundaries_or_location.R

In fergustaylor/openprescribingR: Load OpenPrescribing data directly into R

#'Search for the boundaries of a CCG, or location of a practice, by code. Returns GeoJSON or sfc.
#'
#' @param CCG_code A code assigned to each CCG, found using organisation_details().
#' @param practice_code A code assigned to each Practice, found using organisation_details().
#' @param as_sf If TRUE, Returns as Simple Features Collection instead.
#' @return Returns the boundaries of a CCG, or location of a practice (or practices in a CCG). Returns GeoJSON (or sfc).
#' @importFrom magrittr "%>%"
#' @export
#' @examples
#' All organisations matching a code or name = organisation_codes(organisation_code_or_name= "...")
#' Boundaries of all CCGs = CCG_boundaries_or_location()
#' Boundaries of an individual CCG = CCG_boundaries_or_location(CCG_code = "99H")
#' Location (approximate) of a practice, or practices in a CCG, by code = CCG_boundaries_or_location(CCG_code = "99H", practice_code = "P87003")
#' Location (approximate) of a practice by code = CCG_boundaries_or_location(practice_code = "P87003")
#' Location (approximate) of all practices in a CCG, by code = location_function(CCG_code = "99H")
#' N.B ^ location_function is a bodge using organistation_codes to return a CCG_boundaries_or_location() for all practices in a CCG, but does require a bit more time to download the look-up it needs.
#' 
#' CCG_boundaries_or_location(as_sf = TRUE)
#' CCG_boundaries_or_location(CCG_code = "99H", as_sf = TRUE)
#' CCG_boundaries_or_location(CCG_code = "99H", practice_code = "P87003", as_sf = TRUE)
#' CCG_boundaries_or_location(practice_code = "P87003", as_sf = TRUE)
#' location_function(CCG_code = "99H", as_sf = TRUE)
#' Read the [wiki](https://github.com/fergustaylor/openprescribingR/wiki) for more help.
CCG_boundaries_or_location <- function(CCG_code = NULL, practice_code = NULL, as_sf = TRUE/FALSE) {
  if (is.null(CCG_code) & is.null(practice_code)) {variablesegment <- stringr::str_c("org_type=ccg")}
  if (!is.null(CCG_code) & is.null(practice_code)) {variablesegment <- stringr::str_c("org_type=ccg&q=", CCG_code)}
  if (is.null(CCG_code) & !is.null(practice_code)) {variablesegment <- stringr::str_c("q=", practice_code)}
  if (!is.null(CCG_code) & !is.null(practice_code)) {variablesegment <- stringr::str_c("q=", CCG_code, ",", practice_code)}
  
  if (as_sf == TRUE) {
    stringr::str_c("https://openprescribing.net/api/1.0/", "org_location/?", variablesegment) %>% 
      sf::st_read() %>% 
      sf::st_as_sf()}
  
  else {
    stringr::str_c("https://openprescribing.net/api/1.0/", "org_location/?", variablesegment) %>%
      readLines() %>%
      rjson::fromJSON()}  
}