search

ipeaGIT / gtfs2emis

R package to estimate public transport emissions based on GTFS data
https://ipeagit.github.io/gtfs2emis/
Other
28 stars 2 forks source link

package workflow diagram #80

Closed rafapereirabr closed 2 years ago

rafapereirabr commented 2 years ago

There is new Mermaid syntax that can be used to create diagrem in Markdown. So I thought we could probably create a diagram illustrating the workflow of gtfs2emis. What do you think? here is a 1st general overview.

```mermaid
  graph TD;
      gtfs.zip-->transport_model;
      transport_model-->gps_like;
      gps_like-->emission_model;
      fleet_data.frame-->emission_model;
      pollutant-->emission_model;
      emission_factor_model-->emission_model;
     emission_model-->emission_list
  graph TD;
      gtfs.zip-->transport_model;
      transport_model-->gps_like;
      gps_like-->emission_model;
      fleet_data.frame-->emission_model;
      pollutant-->emission_model;
      emission_factor_model-->emission_model;
     emission_model-->emission_list
Joaobazzo commented 2 years ago

Here's my suggestion. We still need legends for diagrams, so I'm wondering if using Mermaid syntax should be more complicated than making manually.

DiagrammeR("
  graph TD;
       style A fill:#ffffff,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
       style E fill:#ffffff,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
       style F fill:#ffffff,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
       style G fill:#ffffff,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
       style C fill:#ffffff,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
       style B fill:#ffffff,stroke:#333,stroke-width:1.5px
       style D fill:#ffffff,stroke:#333,stroke-width:1.5px
       style H fill:#e6e6fa,stroke:#333,stroke-width:0px
       style J fill:#ffffff,stroke:#333,stroke-width:0px
       style I fill:#e6e6fa,stroke:#333,stroke-width:0px
      style I1 fill:#e6e6fa,stroke:#333,stroke-width:0px
      style I2 fill:#e6e6fa,stroke:#333,stroke-width:0px

      A[gtfs.zip]-->B[transport_model];
      B-->C[GPS like];
      C-->D[Emission model];
      E[Fleet]-->D;
      F[Pollutant]-->D;
      G[Emission factor model]-->D;
      D-->H[Emissions output];
      H---J[Post-processing];
      J-->I[Gridded emissions];
      J-->I1[Emissions by hour];
      J-->I2[Emissions by vehicle];
")

Rplot

Joaobazzo commented 2 years ago

we have an updated version in the article