R/lookupAddressCard.R

In Lyrohk/cruncher: Crunchbase API v4.0

#' Function to lookup and paginate through a single card for a single address over the Entity Lookup API Endpoint
#'
#' Takes the entity id to lookup a card and paginate through the entities and parse them into a data.frame
#'
#'@param address_card card field of interest that will be returned. Only one please!
#'@param address_id UUID or permalink of the address you wish to look up
#'@param please_parse Logical. By default TRUE and will parse your data from a list of data.frames to a final data.frame with empty elements dropping out.
#'@return a data.frame
#'
#' @author Layla Rohkohl, \email{byehity@gmail.com}
#'
#' @examples
#' lookupAddressCard(address_card = "card", address_id = "id")
#'
#'@export
#'
lookupAddressCard <- function(address_card, address_id, please_parse = TRUE) {
  if (length(address_id) == 0) {
    stop("Please provide a valid address_id.")
  } else if (length(address_id) == 1) {
    # Lookup the cards for a single id
    return(lookupEntityCard(entity_card = address_card, entity_id = address_id, entity_path = "addresses"))
  } else {
    # Add duplicate and time check
    duplicateTimeCheck(address_id)

    # Check please_parse
    if (please_parse) {
      # Bind data into a final data.frame with those elements without data dropping out
      return( rbind_pages(silenceFun(lapply(address_id, lookupEntityCard, entity_card = address_card, entity_path = "addresses"))) )
    } else {
      # Return a list of (potentially empty) data.frames
      return(silenceFun(lapply(address_id, lookupEntityCard, entity_card = address_card, entity_path = "addresses")))
    }
  }
}