Skip to content

Data Documentation

james-clark-rsg edited this page Jan 4, 2024 · 3 revisions

Data used within the package are assumed to be under the following format:

hts_data

A list of the tables from the hts

hh

Household Dataset

  • hh_id: 8 digit household ID
  • survey variables asked on a household level
  • hh_weight: household weight

person

Person Dataset

  • hh_id: 8 digit household ID
  • person_id: 10 digit person ID
  • survey variables asked on a person level
  • person_weight: person weight

day

Day Dataset

  • hh_id: 8 digit household ID
  • person_id: 10 digit person ID
  • day_id: 12 digit day ID
  • survey variable asked on a day level
  • day_weight: day weight

trip

Trip dataset

  • hh_id: 8 digit household ID
  • person_id: 10 digit person ID
  • day_id: 12 digit day ID
  • trip_id: 13 digit trip ID
  • survey variables asked on a trip level
  • trip_weight: trip weight

location

Location dataset

  • trip_id: 13 digit trip ID
  • location data

vehicle

Vehicle dataset The variables are as follows:

  • hh_id: 8 digit household ID
  • vehicle_id: 10 digit vehicle ID
  • survey responses asked on a vehicle level
  • hh_weight: household weight

Codebook

variable_list

A dataset containing information about all variables existing in the hh, person, day, trip, and vehicle tables. The variables are as follows:

  • variable: Name of the variable
  • is_checkbox: The variable is a 'Select all that Apply' question
  • hh: The variable exists in the hh table
  • person: The variable exists in the person table
  • day: The variable exists in the day table
  • trip: The variable exists in the trip table
  • vehicle: The variable exists in the vehicle table
  • location: The variable exists in the location table
  • data_type: Data type of the variable
  • description: A description of the variable
  • logic: Conditions where the variable should have a value
  • shared_name: the shared name of checkbox variable or the variable name for non-checkbox variables

value_labels

List of values and their labels

A dataset containing the values for all variables found in variable_list The variables are as follows:

  • variable: Name of the variable
  • value: The numeric value of the variable
  • label: What the numeric value of the variable represents
  • label_value: value concatenated with the label (e.g., 11 85 or older)
  • val_order: order for each variable label to appear in
Clone this wiki locally