Skip to contents

Summary statistics of trips originating from zones in OD data

Source: R/od-funs.R
od_aggregate_from.Rd

This function takes a data frame of OD data and returns a data frame reporting summary statistics for each unique zone of origin.

Usage

od_aggregate_from(flow, attrib = NULL, FUN = sum, ..., col = 1)

Arguments

flow

A data frame representing origin-destination data. The first two columns of this data frame should correspond to the first column of the data in the zones. Thus in cents_sf(), the first column is geo_code. This corresponds to the first two columns of flow().

attrib

character, column names in sl to be aggregated

FUN

A function to summarise OD data by

...

Additional arguments passed to FUN

col

The column that the OD dataset is grouped by (1 by default, the first column usually represents the origin)

Details

It has some default settings: the default summary statistic is sum() and the first column in the OD data is assumed to represent the zone of origin. By default, if attrib is not set, it summarises all numeric columns.

See also

Other od: od2line(), od2odf(), od_aggregate_to(), od_coords2line(), od_coords(), od_id_order(), od_id, od_oneway(), od_to_odmatrix(), odmatrix_to_od(), points2flow(), points2odf()

Examples

od_aggregate_from(flow)
#> # A tibble: 7 × 13
#>   Area.of.residence   All Work.mainly.at.or.from.…¹ Underground..metro..…² Train
#>   <chr>             <int>                     <int>                  <int> <int>
#> 1 E02002361           336                         0                      0     1
#> 2 E02002363           473                         0                      0     2
#> 3 E02002367           302                         0                      0     1
#> 4 E02002371           633                         0                      0     2
#> 5 E02002377           395                         0                      0     0
#> 6 E02002382           277                         0                      0     0
#> 7 E02002393           400                         0                      1     6
#> # ℹ abbreviated names: ¹​Work.mainly.at.or.from.home,
#> #   ²​Underground..metro..light.rail..tram
#> # ℹ 8 more variables: Bus..minibus.or.coach <int>, Taxi <int>,
#> #   Motorcycle..scooter.or.moped <int>, Driving.a.car.or.van <int>,
#> #   Passenger.in.a.car.or.van <int>, Bicycle <int>, On.foot <int>,
#> #   Other.method.of.travel.to.work <int>