get_unique_ids: Get unique origin and destination names

Description Usage Arguments Value Author(s) See Also Examples

View source: R/utils.R

Description

This function builds unique character string identifiers for all origins and destinations.

Usage

1
2
3
4
5
6
7
8
get_unique_ids(
  data,
  orig = TRUE,
  dest = TRUE,
  adm_start = NULL,
  adm_stop = NULL,
  name_class = "character"
)

Arguments

data

generalized data frame described in travel_data_template

orig

logical indicating whether to include unique coordinates from origin locations (default=TRUE)

dest

logical indicating whether to include unique coordinates from destination locations (default=TRUE)

adm_start

highest administrative level to include in unique names (default = NULL, which uses highest observed in the data)

adm_stop

lowest administrative level to include in unique names (default = NULL, which uses lowest observed in the data)

name_class

character indicating whether unique names should be either a unique character string (name_class = "character") or a unique integer code (name_class = "numeric")

Value

two column dataframe containing unique names

Author(s)

John Giles

See Also

Other utility: get_admin_level(), get_beta_params(), get_gamma_params(), get_pop_vec(), get_unique_coords()

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
get_unique_ids(travel_data_sim)

# Starting at admin level 1
get_unique_ids(travel_data_sim, adm_start=1)

# Use numeric facto levels
get_unique_ids(travel_data_sim, name_class='numeric')

# Numeric for only the origin locations
get_unique_ids(travel_data_sim, dest=FALSE, name_class='numeric')

COVID-19-Mobility-Data-Network/mobility documentation built on Nov. 22, 2021, 12:17 a.m.