Skip to content

Commit b2d58e0

Browse files
authored
Updated TOC and links
1 parent 6ccab37 commit b2d58e0

1 file changed

Lines changed: 26 additions & 30 deletions

File tree

metrics/metrics_methodology.md

Lines changed: 26 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,39 @@ This section provides methodologies and sample calculations of [MDS metrics](/me
88

99
**Note 2:** While metrics are designed to be flexible, and allow calculations using any time interval (hourly, daily, monthly), samples in this document are aggregated into 15-mins intervals for simplicity and illustrative purposes.
1010

11-
```
12-
This document will be updated to match in accordance with MDS version 1.0.0
13-
```
14-
1511
## Table of Contents
1612

17-
- [1. MDS Core Metrics](#1.-mds-core-metrics)
18-
- [1.1 vehicles.[state].avg](#1.1-vehicles.[state].avg])
19-
- [1.2 vehicles.[state].min](#1.2-vehicles.[state].min)
20-
- [1.3 vehicles.[state].max](#1.3-vehicles.[state].max)
21-
- [1.4 vehicles.[state].duration.sum](#1.4-vehicles.[state].duration.sum)
22-
- [1.5 events.[event_type].count](#1.5-events.[event_type].count)
23-
- [1.6 trips.[start_loc/end_loc].count](#1.6-trips.[start_loc/end_loc].count)
24-
- [1.7 trips.[start_loc/end_loc]_duration.avg](#1.7-trips.[start_loc/end_loc]_duration.avg)
25-
- [1.8 trips.[start_loc/end_loc]_duration.sum](#1.8-trips.[start_loc/end_loc]_duration.sum)
26-
- [1.9 trips.[start_loc/end_loc]_distance.avg](#1.9-trips.[start_loc/end_loc]_distance.avg)
27-
- [1.10 trips.[start_loc/end_loc]_distance.sum](#1.10-trips.[start_loc/end_loc]_distance.sum)
28-
- [2. MDS Dockless Metrics](#2.-MDS-Dockless-Metrics)
29-
- [2.1 dockless.deployed.avg](#2.1-dockless.deployed.avg)
30-
- [2.2 dockless.deployed.avg.min](#2.2-dockless.deployed.avg.min)
31-
- [2.3 dockless.deployed.min](#2.3-dockless.deployed.min)
32-
- [2.4 dockless.deployed.avg.max](#2.4-dockless.deployed.avg.max)
33-
- [2.5 dockless.deployed.max](#2.5-dockless.deployed.max)
34-
- [2.6 dockless.active.count](#2.6-dockless.active.count)
35-
- [2.7 dockless.inactive.count](#2.7-dockless.inactive.count)
36-
- [2.8 dockless.utilization.idle.percent](#2.8-dockless.utilization.idle.percent)
37-
- [2.9 dockless.utilization.active.percent](#2.9-dockless.utilization.active.percent)
38-
- [2.10 dockless.utilization.trips_per_vehicle.avg](#2.10-dockless.utilization.trips_per_vehicle.avg)
39-
- [Compatibility with Mobility Data Collaborative Metrics](#Compatibility-with-Mobility-Data-Collaborative-Metrics)
13+
- [1. MDS Core Metrics](#1-mds-core-metrics)
14+
- [1.1 vehicles.[state].avg](#11-vehiclesstateavg)
15+
- [1.2 vehicles.[state].min](#12-vehiclesstatemin)
16+
- [1.3 vehicles.[state].max](#13-vehiclesstatemax)
17+
- [1.4 vehicles.[state].duration.sum](#14-vehiclesstatedurationsum)
18+
- [1.5 events.[event_type].count](#15-eventsevent_typecount)
19+
- [1.6 trips.[start_loc/end_loc].count](#16-tripsstart_locend_loccount)
20+
- [1.7 trips.[start_loc/end_loc]_duration.avg](#17-tripsstart_locend_loc_durationavg)
21+
- [1.8 trips.[start_loc/end_loc]_duration.sum](#18-tripsstart_locend_loc_durationsum)
22+
- [1.9 trips.[start_loc/end_loc]_distance.avg](#19-tripsstart_locend_loc_distanceavg)
23+
- [1.10 trips.[start_loc/end_loc]_distance.sum](#110-tripsstart_locend_loc_distancesum)
24+
- [2. MDS Dockless Metrics](#2-mds-dockless-metrics)
25+
- [2.1 dockless.deployed.avg](#21-docklessdeployedavg)
26+
- [2.2 dockless.deployed.avg.min](#22-docklessdeployedavgmin)
27+
- [2.3 dockless.deployed.min](#23-docklessdeployedmin)
28+
- [2.4 dockless.deployed.avg.max](#24-docklessdeployedavgmax)
29+
- [2.5 dockless.deployed.max](#25-docklessdeployedmax)
30+
- [2.6 dockless.active.count](#26-docklessactivecount)
31+
- [2.7 dockless.inactive.count](#27-docklessinactivecount)
32+
- [2.8 dockless.utilization.idle.percent](#28-docklessutilizationidlepercent)
33+
- [2.9 dockless.utilization.active.percent](#29-docklessutilizationactivepercent)
34+
- [2.10 dockless.utilization.trips_per_vehicle.avg](#210-docklessutilizationtrips_per_vehicleavg)
35+
- [Compatibility with Mobility Data Collaborative Metrics](#compatibility-with-mobility-data-collaborative-metrics)
4036

4137
## 1. MDS Core Metrics
4238

4339
Reference to MDS Core Metrics specification in Github: [link](/metrics/core_metrics.md)
4440

4541
### 1.1 `vehicles.[state].avg`
4642

47-
The average number of vehicles in an [MDS state](https://github.com/openmobilityfoundation/mobility-data-specification/tree/release-0.4.1/agency#vehicle-events) during the interval within a geographic area. To calculate **vehicles.[state].avg**, we will take a snapshot of vehicle status every N-period, and average the number of vehicles shown to be in status. The default for N is a 1-minute snapshot, with the goal to compute metrics at the largest interval where the least amount of change will occur. Although depending on use cases and computational capabilities, the snapshot frequency can be configurable.
43+
The average number of vehicles in an [MDS state](../general-information.md#vehicle-states) during the interval within a geographic area. To calculate **vehicles.[state].avg**, we will take a snapshot of vehicle status every N-period, and average the number of vehicles shown to be in status. The default for N is a 1-minute snapshot, with the goal to compute metrics at the largest interval where the least amount of change will occur. Although depending on use cases and computational capabilities, the snapshot frequency can be configurable.
4844

4945
**Sample**
5046

@@ -148,7 +144,7 @@ The sample dataset above will return **vehicles.[state].duration.sum** as shown
148144

149145
### 1.5 `events.[event_type].count`
150146

151-
The number of [MDS events](https://github.com/openmobilityfoundation/mobility-data-specification/tree/release-0.4.1/agency#vehicle-events) received during the time interval within a geographical area.
147+
The number of [MDS events]../agency#vehicle---event) received during the time interval within a geographical area.
152148

153149
**Sample**
154150

@@ -255,7 +251,7 @@ A sample metric output table for **trips.[start_loc/end_loc]_distance.sum**.
255251

256252
## 2. MDS Dockless Metrics
257253

258-
Reference to MDS Dockless Metrics specification in Github: [link](https://github.com/lacuna-tech/mobility-data-specification/blob/add_metrics_definitions/metrics/dockless_metrics.md)
254+
Reference to MDS Dockless Metrics specification in Github: [link](../metrics/dockless_metrics.md)
259255

260256
### 2.1 `dockless.deployed.avg`
261257

0 commit comments

Comments
 (0)