calc.prop.tot.trips: Calculate the cumulative proportion of trips for values of a...

In gilesjohnr/hmob: Tools for analyzing human mobility data

Description

This function takes a longform dataframe of trip counts and calculates the cumulative proportion of the total number of observed trips for each of the values provided in the vals vector.

Usage

calc.prop.tot.trips(
  variable,
  counts,
  type,
  vals,
  parallel = FALSE,
  n.cores = 2
)

Arguments

variable	a vector of variable values for which to calculate the proportion of total trips (e.g. 'duration' or 'distance')
counts	a vector of observed counts of each value
vals	vector giving numeric values of the variable at which to calculate the proportion of total trips
parallel	run in parallel (when the vals vector is long), default=FALSE
n.cores	number of cores to use in parallel

Value

a two-column dataframe

Author(s)

John Giles

See Also

Other data synthesis: calc.route.type(), calc.samp.size(), get.crossdist(), get.distance.class(), get.distance.counts(), get.distance.matrix(), get.district.names.xy(), get.district.pop(), get.duration.counts(), get.holidays(), get.sparse.mob.matrix(), get.stay.data(), get.subsamp(), get.xy.counts(), mob.data.array(), parse.longform()

Examples

# Longform trip lengths with all metadata attached
d <- read.csv("./data/trip_durations_longform_metadata_13_34_42_85_10_14_16_99_urban_rural.csv", stringsAsFactors=F)

# Proportion of total trips with a duration less than the given values
calc.prop.tot.trips(variable=d$duration, 
                    count=d$count, 
                    vals=c(1,3,7), 
                    type='cumulative')

calc.prop.tot.trips(variable=d$duration, 
                    count=d$count, 
                    vals=c(1,3,7), 
                    type='interval')

# Proportion of total trips with a distance less than the given values in parallel
calc.prop.tot.trips(variable=d$distance, 
                    count=d$count, 
                    vals=c(1:100), 
                    type='cumulative',
                    parallel=TRUE,
                    n.cores=4)

calc.prop.tot.trips(variable=d$distance, 
                    count=d$count, 
                    vals=c(1:100), 
                    type='interval',
                    parallel=TRUE,
                    n.cores=4)

gilesjohnr/hmob documentation built on Aug. 8, 2020, 1:26 a.m.