zipcodeR/_pkgdown.yml at master · gavinrozzi/zipcodeR · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
authors:

  Gavin Rozzi:
    href: "https://www.gavinrozzi.com/"

template:
  package: preferably

reference:
  - title: "Recommended API for new analyses"
    desc: >
      Select an immutable modern data bundle, then use the next-generation
      functions. The bundle is always the first argument and is never selected
      or downloaded implicitly.
    contents:
      - download_zip_data_bundle
      - read_zip_data_bundle
      - zip_data_version
      - zip_data_provenance
      - search_state_ng
      - search_county_ng
      - search_city_ng
      - search_tz_ng
      - search_fips_ng
      - search_cd_ng
      - search_radius_ng
      - reverse_zipcode_ng
      - geocode_zip_ng
      - get_tracts_ng
      - get_cd_ng
      - is_zcta_ng
      - normalize_zip_ng
      - zip_distance_ng
  - title: "Historical compatibility API"
    desc: >
      Existing names retain the exact 0.3.5 data and behavior for old scripts
      and research reproduction.
    contents:
      - search_state
      - search_county
      - search_city
      - search_tz
      - search_fips
      - search_cd
      - search_radius
      - reverse_zipcode
      - geocode_zip
      - get_tracts
      - get_cd
      - is_zcta
      - normalize_zip
      - zip_distance
      - download_zip_data
  - title: "Data objects"
    contents:
      - zip_code_db
      - zcta_crosswalk
      - zip_to_cd
  - title: "Optional comprehensive data"
    contents:
      - download_comprehensive_data