R/lookupPeople.R

In Lyrohk/cruncher: Crunchbase API v4.0

#' Function to lookup a multiple people over the Entity Lookup API Endpoint
#'
#'@param persons UUID or permalink of the people you wish to look up
#'@param please_parse Logical. By default TRUE. If set to FALSE, it will return the data directly from the JSON, if set to TRUE, it will parse it into a data.frame object
#'@param print_error Logical. Default to TRUE and thus if the request fails, an error message will be printed out.
#'@return either a data.frame (if please_parse = TRUE) or a list of lists (if please_parse = FALSE)
#'
#' @author Layla Rohkohl, \email{byehity@gmail.com}
#'
#' @examples
#' lookUpPersons(c("mark-zuckerberg", "roland-berger"))
#' lookUpPersons(list("mark-zuckerberg", "roland-berger"))
#'
#' @import dplyr
#' @export
#'
# Lookup multiple organizations
lookupPeople <- function(persons, please_parse = TRUE, print_error = TRUE) {
  return(lookupEntities(entities = persons, path = "people", please_parse = please_parse, print_error = print_error))
}