R/get_ly_legislators_by_term.R

In yl17124/legisTaiwan: An Interface to Access Taiwan Legislative API in R

#' Get Legislative Yuan Legislators by Term
#'
#' @title Fetch Legislators List for a Specific Term 依屆期取得立法委員名單
#'
#' @description
#' Retrieves a paginated list of legislators for a specific Legislative Yuan term.
#' The function provides detailed information about legislators including their names,
#' parties, and represented areas. It also includes metadata about the total number
#' of legislators and pagination information.
#'
#' @param term required integer. Legislative term number (e.g., 9)
#' @param page integer. Page number for pagination (default: 1)
#' @param limit integer. Number of records per page (default: 20)
#' @param show_progress logical. Whether to display progress bar and summary statistics (default: TRUE)
#'
#' @return A list with two components:
#' \describe{
#'   \item{metadata}{A list containing:
#'     \describe{
#'       \item{total}{Total number of legislators}
#'       \item{total_page}{Total number of pages}
#'       \item{current_page}{Current page number}
#'       \item{per_page}{Number of records per page}
#'     }
#'   }
#'   \item{legislators}{A data frame containing legislator information:
#'     \describe{
#'       \item{term}{Legislative term}
#'       \item{name}{Legislator's name}
#'       \item{party}{Political party affiliation}
#'       \item{areaName}{Represented area (if available)}
#'       \item{columns}{Additional columns as provided by the API}
#'     }
#'   }
#' }
#'
#' @details
#' The function includes a progress bar and detailed summary statistics when
#' show_progress is TRUE. The summary includes:
#' \describe{
#'   \item{Total Statistics}{Total number of legislators}
#'   \item{Pagination}{Current page and total pages}
#'   \item{Page Size}{Records per page}
#'   \item{Distribution}{Party and area distribution (if available)}
#' }
#'
#' @examples
#' \dontrun{
#' # Get first page of legislators for term 9
#' result <- get_ly_legislators_by_term(term = 9)
#'
#' # Get second page with 30 records per page
#' result <- get_ly_legislators_by_term(
#'   term = 9,
#'   page = 2,
#'   limit = 30
#' )
#'
#' # Access the results
#' metadata <- result$metadata
#' legislators_df <- result$legislators
#'
#' # Display total number of legislators
#' cat("Total legislators:", metadata$total, "\n")
#'
#' # Show first few rows of legislator data
#' head(legislators_df)
#' }
#'
#' @seealso
#' \describe{
#'   \item{get_ly_legislator_detail}{\code{\link{get_ly_legislator_detail}} for getting detailed information about a specific legislator}
#' }
#'
#' @importFrom httr GET content status_code
#' @importFrom jsonlite fromJSON
#' @importFrom utils setTxtProgressBar txtProgressBar
#' @encoding UTF-8
#' @export
get_ly_legislators_by_term <- function(
    term,
    page = 1,
    limit = 20,
    show_progress = TRUE
) {
  # Parameter validation
  if (missing(term)) {
    stop("term parameter is required")
  }
  if (!is.numeric(term)) {
    stop("term must be numeric")
  }
  # Initialize progress
  if(show_progress) {
    cat(sprintf("\nFetching legislators data for term %d...\n", term))
    pb <- txtProgressBar(min = 0, max = 100, style = 3)
    setTxtProgressBar(pb, 20)
  }

  # Base URL
  base_url <- sprintf("https://ly.govapi.tw/legislator/%d", term)

  # Query parameters
  query_params <- list(
    page = page,
    limit = limit
  )

  # Update progress - API call
  if(show_progress) {
    setTxtProgressBar(pb, 40)
  }

  # Send GET request
  response <- httr::GET(
    base_url,
    query = query_params
  )

  # Check response status
  if (httr::status_code(response) != 200) {
    if(show_progress) close(pb)
    stop("API request failed with status code: ", httr::status_code(response))
  }

  # Update progress - parsing
  if(show_progress) {
    setTxtProgressBar(pb, 60)
  }

  # Parse response
  content <- httr::content(response, "text", encoding = "UTF-8")
  data <- jsonlite::fromJSON(content, simplifyDataFrame = TRUE, flatten = TRUE)

  # Extract metadata
  metadata <- list(
    total = data$total$value,
    total_page = data$total_page,
    current_page = data$page,
    per_page = data$limit
  )

  # Update progress - data processing
  if(show_progress) {
    setTxtProgressBar(pb, 80)
  }

  # Process legislators data
  if (length(data$legislators) > 0) {
    legislators_df <- data.frame(
      data$legislators,
      stringsAsFactors = FALSE
    )
  } else {
    legislators_df <- data.frame(
      term = integer(),
      name = character(),
      party = character(),
      stringsAsFactors = FALSE
    )
  }

  # Update progress - complete
  if(show_progress) {
    setTxtProgressBar(pb, 100)
    close(pb)

    # Print summary
    cat("\n\n")
    cat("====== Retrieved Information ======\n")
    cat("-----------------------------------\n")
    cat(sprintf("Total Legislators: %d\n", metadata$total))
    cat(sprintf("Page: %d of %d\n", metadata$current_page, metadata$total_page))
    cat(sprintf("Records per page: %d\n", metadata$per_page))

    if(nrow(legislators_df) > 0) {
      # Add party distribution
      party_counts <- table(legislators_df$party)
      cat("\nParty Distribution:\n")
      for(party in names(party_counts)) {
        cat(sprintf(" %s: %d\n", party, party_counts[party]))
      }

      # Add area distribution if available
      if("areaName" %in% names(legislators_df)) {
        area_counts <- table(legislators_df$areaName)
        cat("\nArea Distribution:\n")
        for(area in names(area_counts)) {
          cat(sprintf(" %s: %d\n", area, area_counts[area]))
        }
      }
    }
    cat("===================================\n")
  }

  return(list(
    metadata = metadata,
    legislators = legislators_df
  ))
}