Skip to contents

Returns the BMF data dictionary as a tibble, with optional grep filtering on column names. Use this to discover available columns before calling [nccs_read()].

Usage

nccs_dictionary(pattern = NULL)

Arguments

pattern

Optional character string. If provided, filters the dictionary to column names matching this pattern (case-insensitive regular expression).

Value

A tibble with columns `column_name`, `description`, and `type`.

Examples

# See all columns
nccs_dictionary()
#> # A tibble: 97 × 3
#>    column_name                 description                                 type 
#>    <chr>                       <chr>                                       <chr>
#>  1 accounting_period           Month when organizations accounting period… inte…
#>  2 activity_code               Three 3-digit activity codes concatenated … inte…
#>  3 activity_code_categories    Semicolon-separated activity categories     char…
#>  4 activity_code_definitions   Semicolon-separated descriptions of activi… char…
#>  5 affiliation_code            Code indicating relationship to parent org… inte…
#>  6 affiliation_code_definition Description of affiliation relationship     char…
#>  7 all_classifications_string  Semicolon-separated list of all classifica… char…
#>  8 asset_amount                Total assets in dollars (most recent retur… nume…
#>  9 asset_code                  Asset amount range code (0-9)               inte…
#> 10 asset_code_definition       Description of asset range (e.g. $100000 t… char…
#> # ℹ 87 more rows

# Find geocoding-related columns
nccs_dictionary("geo")
#> # A tibble: 19 × 3
#>    column_name      description                                            type 
#>    <chr>            <chr>                                                  <chr>
#>  1 geo_addr_type    Geocoder match precision level (PointAddress StreetAd… char…
#>  2 geo_city         City name from geocoder                                char…
#>  3 geo_country      Country code from geocoder (e.g. USA) for identifying… char…
#>  4 geo_county       County name from geocoder                              char…
#>  5 geo_distance     Distance in meters between input address and matched … nume…
#>  6 geo_is_geocoded  TRUE if latitude and longitude are non-NA              logi…
#>  7 geo_lat          WGS 84 latitude (EPSG 4326) from geocoder              nume…
#>  8 geo_lon          WGS 84 longitude (EPSG 4326) from geocoder             nume…
#>  9 geo_match_addr   Address the geocoder actually matched to               char…
#> 10 geo_match_type   Geocoder match type (A=address match) distinguishing … char…
#> 11 geo_metro_area   Metropolitan area name from geocoder (may be blank)    char…
#> 12 geo_neighborhood ESRI-defined neighborhood from geocoder                char…
#> 13 geo_postal       ZIP code resolved by geocoder for cross-referencing w… inte…
#> 14 geo_postal_ext   ZIP+4 extension resolved by geocoder                   char…
#> 15 geo_precision    Geocoding precision tier derived from geo_addr_type (… char…
#> 16 geo_score        Geocoder match confidence score (1-100)                nume…
#> 17 geo_state        State name from geocoder                               char…
#> 18 geo_state_abbr   State abbreviation from geocoder                       char…
#> 19 geo_status       Geocoder match status (M=Match T=Tied U=Unmatched)     char…

# Find NTEE-related columns
nccs_dictionary("ntee")
#> # A tibble: 10 × 3
#>    column_name                 description                                 type 
#>    <chr>                       <chr>                                       <chr>
#>  1 ntee_code_clean             Standardized 3-character NTEE code          char…
#>  2 ntee_code_definition        Full description of NTEE classification     char…
#>  3 ntee_code_major_group       NTEE major group letter (A-Z) indicating b… char…
#>  4 ntee_code_raw               Original NTEE code from source file (1-4 c… char…
#>  5 ntee_common_code            Common code suffix for 4-character NTEE co… char…
#>  6 ntee_common_code_definition Description of common code suffix           char…
#>  7 nteev2                      Full NTEEv2 code in SUBSECTOR-CODE-TYPE fo… char…
#>  8 nteev2_code                 NTEEv2 code portion (3 characters)          char…
#>  9 nteev2_org_type             NTEEv2 organization type (RG=Regular AA=Al… char…
#> 10 nteev2_subsector            NTEEv2 subsector code (e.g. UNI HOS ART EN… char…