Legacy Scottish Post Office Directories Cleaner

Documentation for package ‘podcleaner’ version 0.1.2

Help Pages

-- C --

clean_address_attached_words	Clean attached words in address entry(/ies)
clean_address_body	Clean address entry(/ies) body
clean_address_ends	Clean ends in address entry(/ies)
clean_address_mac	Standardise "Mac" prefix in address entry(/ies)
clean_address_names	Clean place name(s) in address entry(/ies)
clean_address_number	Clean address entry numbers
clean_address_others	Miscellaneous cleaning operations in address entry(/ies)
clean_address_places	Clean places in address entry(/ies)
clean_address_possessives	Standardise possessives in address entry(/ies)
clean_address_post_clean	Post-cleaning operation for address entry(/ies)
clean_address_pre_clean	Pre-cleaning operation for address entry(/ies)
clean_address_saints	Clean "Saint" prefix in address entry(/ies)
clean_address_suffixes	Clean unwanted suffixes in address entry(/ies)
clean_address_worksites	Clean worksites in address entry(/ies)
clean_forename	Clean entry(/ies) forename
clean_forename_punctuation	Standardise punctuation in forename(s)
clean_forename_separate_words	Separate double-barrelled forename(s)
clean_forename_spelling	Clean forename(s) spelling
clean_mac	Standardise "Mac" prefix in people's name
clean_name_ends	Clean ends in entry(/ies) names
clean_occupation	Clean entry(/ies) occupation
clean_parentheses	Clean entry(/ies) of in brackets information
clean_specials	Clean entry(/ies) special characters
clean_string_ends	Clean string ends
clean_surname	Clean entry(/ies) surname
clean_surname_punctuation	Standardise punctuation in surname(s)
clean_surname_spelling	Clean surname(s) spelling
clean_title	Clean entry(/ies) name title
combine_get_address_house_type	Get house address column type
combine_has_match_failed	Check for failed matches
combine_label_failed_matches	Label failed matches
combine_label_if_match_failed	Label failed matches
combine_make_match_string	Mutate operation(s) in directory data.frame trade address column
combine_match_general_to_trades	Match general to trades directory records
combine_match_general_to_trades_plain	Match general to trades directory records
combine_match_general_to_trades_progress	Match general to trades directory records
combine_no_trade_address_to_random_string	Mutate operation(s) in directory data.frame address.trade column.
combine_random_string_if_no_address	Conditionally return a random string
combine_random_string_if_pattern	Conditionally return a random string

-- G --

general_clean_directory	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_clean_directory_plain	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_clean_directory_progress	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_clean_entries	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_fix_structure	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_move_house_to_address	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_repatriate_occupation_from_address	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_split_address_numbers_bodies	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_split_trade_addresses	Mutate operation(s) in Scottish post office general directory data.frame column(s)
general_split_trade_house_addresses	Mutate operation(s) in Scottish post office general directory data.frame column(s)
globals_address_names	Place names in address entries
globals_ampersand	Ampersand in directory entries
globals_ampersand_vector	Ampersand in directory entries
globals_and_double_quote	Ampersand in directory entries
globals_and_single_quote	Ampersand in directory entries
globals_forenames	Forenames in directory records
globals_general_colnames	General directory column names
globals_macs	"Mac" pre-fixes in name entries
globals_numbers	Numbers in address entries
globals_occupations	Occupations in directory records
globals_places_raw	Place types in address entries
globals_places_regex	Place types in address entries
globals_regex_address_house_body_number	Regular expression for mutate operations in directory datasets
globals_regex_address_prefix	Regular expression for mutate operations in directory datasets
globals_regex_and_filter	Regular expression for mutate operations in directory datasets
globals_regex_and_match	Regular expression for mutate operations in directory datasets
globals_regex_get_address_house_type	Regular expression for mutate operations in directory datasets
globals_regex_house_split_trade	Regular expression for mutate operations in directory datasets
globals_regex_house_to_address	Regular expression for mutate operations in directory datasets
globals_regex_irrelevants	Regular expression for mutate operations in directory datasets
globals_regex_occupation_from_address	Regular expression for mutate operations in directory datasets
globals_regex_split_address_body	Regular expression for mutate operations in directory datasets
globals_regex_split_address_empty	Regular expression for mutate operations in directory datasets
globals_regex_split_address_numbers	Regular expression for mutate operations in directory datasets
globals_regex_split_trade_addresses	Regular expression for mutate operations in directory datasets
globals_regex_titles	Regular expression for mutate operations in directory datasets
globals_saints	Saints in address names
globals_suffixes	Address suffixes
globals_surnames	Surnames in directory records
globals_titles	Titles in directory name records
globals_trades_colnames	Trades directory column names
globals_union_colnames	Combined directories column names
globals_worksites	Worksites in address entries

-- T --

trades_clean_directory	Mutate operation(s) in Scottish post office trades directory data.frame column(s)
trades_clean_directory_plain	Mutate operation(s) in Scottish post office trades directory data.frame column(s)
trades_clean_directory_progress	Mutate operation(s) in Scottish post office trades directory data.frame column(s)
trades_clean_entries	Mutate operation(s) in Scottish post office trades directory data.frame column(s)

-- U --

utils_clean_address	Clean directory address entries
utils_clean_addresses	Clean directory addresses
utils_clean_address_body	Clean address(es) body
utils_clean_address_ends	Clean address entry ends
utils_clean_address_number	Clean address(es) number
utils_clean_ends	Clean entry ends
utils_clean_names	Clean entries name records
utils_clean_occupations	Clean entries occupation record
utils_clear_content	Clear string of matched content
utils_clear_irrelevants	Mutate operation(s) in directory dataframe column(s)
utils_execute	Execute function
utils_format_directory_raw	Format raw directory for further processing
utils_gsub_if_found	Conditionally amend character string vector.
utils_IO_load	Load object into memory
utils_IO_path	Make path for input/output operations
utils_IO_write	Write object to long term memory
utils_is_address_missing	Check is address entry not missing
utils_label_address_if_missing	Label addresses if missing
utils_label_missing_addresses	Label empty addresses as missing
utils_load_directories_csv	Load directory "csv" file(s) into memory
utils_make_file	Make file name
utils_make_path	Make destination path
utils_mutate_across	Mutate operation(s) in dataframe column(s)
utils_mute	Mute a function call execution
utils_paste_if_found	Conditionally amend character string vector.
utils_regmatches_if_found	Conditionally amend character string vector.
utils_regmatches_if_not_empty	Conditionally amend character string vector.
utils_remove_address_prefix	Clear undesired address prefixes
utils_split_and_name	Split string into tibble
utils_squish_all_columns	Clear extra white spaces in dataframe