Skip to contents

Using the App / Api

app()
Get an instance of the interactive shiny occupation coding app.
create_app_settings()
Create app_settings.
api()
Start the occupation coding API.

Questionnaires

Pre-Built

Pre-built questionnaires for use within the interactive app. These can be extended using pages.

questionnaire_demo()
A demo questionnaire with additional explanations
questionnaire_interviewer_administered()
A questionnaire for interviewer-administered surveys
questionnaire_web_survey()
A web survey which participants can navigate themselves.

Page

Functions to create pages to either extend the existing questionnaires or build your own from scratch.

new_page()
Create a new questionnaire page.
page_choose_one_option()
Show a page with multiple radio button options where once can be picked.
page_feedback()
Page to receive feedback on how well the chosen suggestion fits
page_final()
A final page, showing instructions to close the window.
page_first_freetext()
The first freetext question to show.
page_followup()
Show potential followup questions to the user.
page_freetext()
Show a page with a text field where free text can be entered.
page_none_selected_freetext()
An additional freetext page to show when no suggestion has been selected.
page_results()
Page showing the user's results
page_second_freetext()
An optional, second free text question if the first didn't yield suggestions.
page_select_suggestion()
Display the generated suggestions for the user to pick one.
page_welcome()
Welcome Page (optional)
set_item_data()
Set / save data for an item.
get_item_data()
Retrieve data for an item.
button_next() button_previous()
Go to the next page

Creating Suggestions

Functions to create suggestions manually e.g. for generating suggestions post-hoc or for use within another package.

Main

get_final_codes()
Get the final occupation codes
get_followup_questions()
Get potential follow-up questions for a suggestion.
get_item_data()
Retrieve data for an item.
get_job_suggestions()
Make coding suggestions based on a user's open-ended text input.
get_responses()
Convenience function to aggregate all saved results_overview files.
preprocess_string()
Preprocess a string, removing special characters and handling abbreviations.

Algorithms

train_similarity_based_reasoning()
Train Similarity Based Probability Model with anonymized training data
algo_similarity_based_reasoning()
Make suggestions using similarity based reasoning.

Datasets

auxco
German Auxiliary Classification of Occupations (AuxCO) v1.2.3
isco_08_en
Categories of the The International Standard Classification of Occupations - ISCO-08
pretrained_models
Pretrained ML models to be used with the package.
load_auxco()
Load AuxCO from a directory of CSV files
load_kldb_raw() load_kldb()
Clean & Load KldB 2010 dataset.