_pkgdown.yml

destination: public
url: https://ccao-data.github.io/ccao/

authors:
  sidebar:
    roles: [aut, ctb]
  Dan Snow:
    href: https://github.com/dfsnow
  William Ridgeway:
    href: https://github.com/wrridgeway

reference:

- title: Functions
- subtitle: Measure assessment performance
  desc: >
    Calculate assessment performance statistics in accordance with the CCAO
    Data Science Department’s Standard Operating Procedure on Sales Ratio Studies.
    The main changes are enforcement of outlier trimming (top and bottom 5% of
    ratios are always dropped) and a strict minimum sample size (N must be >= 30).
    Each function outputs a named list containing the statistic, its confidence
    interval, whether or not the IAAO standard was met, and the number of
    observations used to calculate the statistic.
- contents:
  - ccao_cod
  - ccao_prd
  - ccao_prb
- subtitle: Format data
  desc: Clean and format Property Index Numbers (PINs)
- contents:
  - pin_clean
  - pin_format_pretty
- subtitle: Lookup values
  desc: Convert between township names, assessment years, and triads
- contents:
  - town_convert
  - town_get_assmnt_year
  - town_get_triad
- subtitle: Manage characteristics
  desc: Recode/rename characteristic columns, merge HIE data, and fix characteristic errors
- contents:
  - chars_288_active
  - chars_fix_age
  - chars_sparsify
  - chars_update
  - vars_recode
  - vars_rename
- subtitle: Adjust estimated values
  desc: Apply post-modeling adjustments to raw model values
  contents:
  - val_round_fmv
  - val_limit_ratios
- subtitle: Miscellaneous functions
  desc: Functions with no other suitable category
  contents:
  - ccao_generate_id

- title: Data
- subtitle: Dictionaries
  desc: Lookups for numeric codes used in the assessment system
- contents:
  - ends_with("_dict")
  - ends_with("_dict_legacy")
- subtitle: Spatial data
  desc: CCAO-specific spatial boundaries. Must load `sf` library before using
- contents:
  - nbhd_shp
  - town_shp
- subtitle: Sample data
  desc: Sample data frames pulled directly from CCAO SQL or Athena
- contents:
  - chars_sample_athena
  - chars_sample_hie
  - chars_sample_universe
- subtitle: Miscellaneous
  desc: Other data used throughout the department or in specific functions
- contents:
  - ccao_colors
  - chars_cols