Skip to contents

Agency Overview Information

Source: R/agency.R
agency_overview.Rd

Retrieves basic information about a federal agency including name, abbreviation, mission statement, website, and other metadata.

Usage

agency_overview(toptier_code, ...)

Arguments

toptier_code

A character string containing a 3-4 digit numeric code that uniquely identifies a top-tier federal agency (e.g., "086" for Department of Housing and Urban Development). Must be a valid CGAC (Common Government-wide Accounting Classification) or FREC (Federal Record Classification) code.

...

Additional parameters passed to specific API endpoints. Common options include:

  • page: Integer specifying the page number to retrieve (default: 1)

  • limit: Integer specifying number of records per page (default: 10)

  • sort: Field to sort results by (varies by endpoint)

  • order: Sort direction: "asc" or "desc" (default varies by endpoint)

Value

A tibble containing agency overview information:

  • fiscal_year: Current fiscal year

  • toptier_code: Agency identifier code

  • name: Full agency name

  • abbreviation: Agency abbreviation

  • agency_id: Numeric agency identifier

  • icon_filename: Agency icon file name

  • mission: Agency mission statement

  • website: Agency website URL

  • congressional_justification_url: URL to budget justification

  • about_agency_data: Additional agency information

  • subtier_agency_count: Number of sub-agencies

See also

agency_sub_components(), agency_budget_resources()

Examples

if (FALSE) { # interactive()
# Get overview for Department of Housing and Urban Development
hud_overview <- agency_overview("086")
}