R/get_donations.R

In infoDemocracy/RinfoDemocracy: R package for infoDemocracy

#' Get donations
#'
#' This function gets live data about donations from the Electoral Commission donations database.
#'
#' @return A data.frame. Variable names are cleaned.
#'
#' @examples
#' get_donations()
#' @name get_donations
#' @importFrom magrittr %>%
NULL

#' @rdname get_donations
#' @export

get_donations <- function() {
  
  ec_donations_raw <- httr::GET('http://search.electoralcommission.org.uk/api/csv/Donations',
                          query = list(sort = "AcceptedDate",
                                       order = "desc",
                                       prePoll = "true",
                                       postPoll = "true")) %>% 
    httr::content(
      type = "text/csv",
      encoding = 'UTF-8',
      col_types = readr::cols(
        ECRef = readr::col_character(),
        RegulatedEntityName = readr::col_character(),
        RegulatedEntityType = readr::col_character(),
        Value = readr::col_character(),
        AcceptedDate = readr::col_date(format = '%d/%m/%Y'),
        AccountingUnitName = readr::col_character(),
        DonorName = readr::col_character(),
        AccountingUnitsAsCentralParty = readr::col_logical(),
        IsSponsorship = readr::col_logical(),
        DonorStatus = readr::col_character(),
        RegulatedDoneeType = readr::col_character(),
        CompanyRegistrationNumber = readr::col_character(),
        Postcode = readr::col_character(),
        DonationType = readr::col_character(),
        NatureOfDonation = readr::col_character(),
        PurposeOfVisit = readr::col_character(),
        DonationAction = readr::col_character(),
        ReceivedDate = readr::col_date(format = '%d/%m/%Y'),
        ReportedDate = readr::col_date(format = '%d/%m/%Y'),
        IsReportedPrePoll = readr::col_logical(),
        ReportingPeriodName = readr::col_character(),
        IsBequest = readr::col_logical(),
        IsAggregation = readr::col_logical(),
        RegulatedEntityId = readr::col_double(),
        AccountingUnitId = readr::col_double(),
        DonorId = readr::col_double(),
        CampaigningName = readr::col_character(),
        RegisterName = readr::col_character(),
        IsIrishSource = readr::col_logical()
        ),
      na = c("", "NA", "N/A"))
  
  readr::stop_for_problems(ec_donations_raw)
  
  ec_donations_raw <- 
    ec_donations_raw %>% 
    dplyr::rename(
      dntn_ec_ref = ECRef,
      dntn_regulated_entity_name = RegulatedEntityName,
      dntn_regulated_entity_type = RegulatedEntityType,
      dntn_value = Value,
      dntn_accepted_date = AcceptedDate,
      dntn_accounting_unit_name = AccountingUnitName,
      dntn_donor_name = DonorName,
      dntn_accounting_unit_as_central_party = AccountingUnitsAsCentralParty,
      dntn_is_sponsorship = IsSponsorship,
      dntn_donor_status = DonorStatus,
      dntn_regulated_donee_type = RegulatedDoneeType,
      dntn_company_registration_number = CompanyRegistrationNumber,
      dntn_postcode = Postcode,
      dntn_donation_type = DonationType,
      dntn_nature_of_donation = NatureOfDonation,
      dntn_purpose_of_visit = PurposeOfVisit,
      dntn_donation_action = DonationAction,
      dntn_received_date = ReceivedDate,
      dntn_reported_date = ReportedDate,
      dntn_is_reported_pre_poll = IsReportedPrePoll,
      dntn_reporting_period_name = ReportingPeriodName,
      dntn_is_bequest = IsBequest,
      dntn_is_aggregation = IsAggregation,
      dntn_regulated_entity_id = RegulatedEntityId,
      dntn_accounting_unit_id = AccountingUnitId,
      dntn_donor_id = DonorId,
      dntn_campaigning_name = CampaigningName,
      dntn_register_name = RegisterName,
      dntn_is_irish_source = IsIrishSource) %>%
    dplyr::mutate(
      dntn_value = as.numeric(stringr::str_replace_all(dntn_value, '[\\£|,]', '')),
      download_date = lubridate::today(),
      type = "Donation")
  
  ec_donations_raw
}