get_locations: Access flow data

View source: R/get_locations.R

get_locationsR Documentation

Access flow data

Description

This accessor extract location data from an epiflows object. get_locations is a generic with a method defined for epiflows objects.

Usage

get_locations(x, ...)

## S3 method for class 'epiflows'
get_locations(x, ...)

Arguments

x

An epiflows object.

...

unused

Value

A data.frame with at least 1 column called id, specifying the id of the location used in the flows data frame.

Author(s)

Thibaut Jombart, Zhian Kamvar

See Also

get_flows(); get_id(); get_pop_size(); get_vars(); get_coordinates(); global_vars()

Examples

data("Brazil_epiflows")
get_locations(Brazil_epiflows)

reconhub/epiflows documentation built on Sept. 21, 2023, 1:17 p.m.