Package index • titleclassifier

Pipeline steps

The eight-step title classification pipeline, in order.

standardize_df(): Standardize the compensation table data frame (from 990 form, Part VII, Table 01)

remove_dates(): remove/clean dates wrapper function, takes in a data frame

standardize_conj(): split conjunctions function

split_titles(): split titles wrapper function

standardize_spelling(): standardize spelling wrapper function

gen_status_codes(): generate status codes wrapper function

standardize_titles(): standardize titles function

categorize_titles(): categorize titles function

conditional_logic(): conditional logic function

gen_taxonomy(): generate taxonomy function

Data acquisition

Fetch Part VII compensation tables from the NCCS efile store.

fetch_partvii(): Fetch Part VII compensation tables from the NCCS efile store

read_partvii(): Read cached Part VII compensation table(s)

get_partvii(): Fetch and read Part VII compensation tables in one call

Crosswalk loaders

Load the bundled title/status/taxonomy crosswalk snapshots (or refresh from Google Sheets).

get_googlesheets_status_codes(): Load the status-code crosswalk

get_googlesheets_title_xwalk(): Load the title-standardization crosswalk

get_googlesheets_title_taxonomy(): Load the title-taxonomy crosswalk

Spelling & cleaning helpers

The fix_* routines used inside standardize_spelling().

fix_academics(): standardize versions of 'academics'

fix_admin(): standardize versions of 'admin'

fix_admissions(): standardize versions of 'admissions'

fix_advancement(): standardize versions of 'advancement'

fix_assistant(): standardize versions of 'assistant'

fix_atlarge(): standardize versions of 'at large'

fix_board(): standardize versions of 'board'

fix_business(): standardize versions of 'business'

fix_chair(): standardize versions of 'chair'

fix_comm(): standardize abbreviations for 'comm'

fix_compliance(): standardize versions of 'compliance'

fix_coordinator(): standardize versions of 'coordinator'

fix_corresponding(): standardize versions of 'corresponding'

fix_deputy(): standardize versions of 'deputy'

fix_development(): standardize versions of 'development'

fix_director(): standardize versions of 'director'

fix_double_and(): double 'and' split rule

fix_emeritus(): standardize versions of 'emeritus'

fix_enrollment(): standardize versions of 'enrollment'

fix_executive(): standardize versions of 'executive'

fix_exofficio(): standardize versions of 'ex officio'

fix_finance(): standardize versions of 'finance'

fix_general(): standardize versions of 'general'

fix_governor(): standardize versions of 'governor'

fix_hr(): standardize versions of 'human resources'

fix_information(): standardize versions of 'information'

fix_institute(): standardize versions of 'institute' (root of institutional)

fix_intelligence(): standardize versions of 'intelligence'

fix_manage(): standardize versions of 'manage' (root of management)

fix_marketing(): standardize versions of 'marketing'

fix_member(): standardize versions of 'member'

fix_miscellaneous(): standardize miscellaneous list of misspellings and abbreviations

fix_misc_splits(): misc split rules

fix_of(): fix "of" function

fix_officer(): standardize versions of 'officer'

fix_operations(): standardize versions of 'operations'

fix_philanthropy(): standardize versions of 'philanthropy'

fix_planning(): standardize versions of 'planning'

fix_president(): standardize versions of 'president'

fix_programs(): standardize versions of 'programs'

fix_projects(): standardize versions of 'projects'

fix_public(): standardize versions of 'public'

fix_relations(): standardize versions of 'relations'

fix_representative(): standardize versions of 'representative'

fix_secretary(): standardize versions of 'secretary'

fix_senior(): standardize versions of 'seniority'

fix_spelling(): fixes spelling wrapper function

fix_strategy(): standardize versions of 'strategy'

fix_systems(): standardize versions of 'systems'

fix_technology(): standardize versions of 'technology'

fix_transportation(): standardize versions of 'transportation'

fix_treasurer(): standardize versions of treasurer helper function

fix_vice(): standardize versions of 'vice'

Step helpers

Lower-level functions used inside the pipeline steps. Currently exported to aid debugging and refinement; several are slated to become internal (see TODO.md).

add_features(): engineer new features from existing fields

add_status_flag(): add a boolean status flag to the compensation dataframe

amp_helper(): ampersand standardization helper function

and_helper(): and standardization helper function

apply_misc_split_rules(): misc split rules for edge cases

basic_csuite_fixes(): basic c-suite fixes wrapper function

clean_up_ceos(): clean up ceos function

comma_helper(): standardize comma helper function

condense_abbreviations(): condense c-suite abbreviations function

convert_ordinal(): convert ordinal numbers function

director_correction(): director correction function

flag_and_keep(): create a status code flag and KEEP the standardized version of the string

flag_and_remove(): create a status code flag and remove string from title

gen_helpful_tables(): gen helpful tables function

get_title_dump(): get title dump function

get_variants(): retrieve all status variants for a unique status code

has_date(): identify dates

identify_split_num(): identify split num function

of_title_helper(): standardize titles something 'of' something

pre_clean(): pre cleaning function

remove_date(): remove date

remove_first_split(): remove first split function

remove_status(): remove a status qualifier from the title

remove_trailing_conjunctions(): remove trailing conjunctions

replace_ceo(): replace ceo function

replace_cfo(): replace cfo function

simplify_clevels(): standardize title mapping function

simplify_varnames(): rename variables in the dataset

slash_helper(): standardize slash helper function

spellcheck(): spell check function

standardize_and(): standardize "and" function

standardize_comma(): standardize comma function

standardize_of(): standardize "of" usage function

standardize_separator(): standardize separator function

standardize_slash(): standardize slash function

standardize_status(): replace status variant with the standardized version

standardize_to(): standardize "to" function

to_helper(): standardize to helper function

Testing helpers

Ad-hoc test harnesses (to be folded into the test suite; see TODO.md).

test_fix_spelling(): test 'fix_spelling' function

test_remove_dates(): test 'remove_dates' function

test_standardize_and(): test 'standardize_and' function

test_standardize_comma(): test 'standardize_comma' function

test_standardize_of(): test 'standardize_of' function

test_standardize_separator(): test 'standardize_separator' function

test_standardize_slash(): test 'standardize_slash' function

test_standardize_to(): test 'standardize_to' function

Datasets

Bundled demo data, dictionaries, and crosswalk snapshots.

date.words: Helper data list.

number.words: Helper data list.

likely.subjects: Helper data list.

likely.titles: Helper data list.

possible.titles: Helper data list.

former.words: Helper data list.

future.words: Helper data list.

interim.words: Helper data list.

regional.words: Helper data list.

possible.regional.list: Helper data list.

raw.titles: Example titles.

tinypartvii: Sample of 10,000 orgs (~81,000 titles) as a Part VII data frame.

df.standard: Title standardization crosswalk (variant to standard).

d.taxonomy: Title taxonomy table.

status.mapping: Status-code mapping table.