Skip to content

Commit

Permalink
Update workflow diagram for CovidTimelineCanada
Browse files Browse the repository at this point in the history
- Closes #24
  • Loading branch information
jeanpaulrsoucy committed Nov 22, 2022
1 parent c1edeb9 commit 08fe5e8
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 21 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ These efforts are part of the **[What Happened? COVID-19 in Canada](https://what

### Flowchart for `CovidTimelineCanada`

This flowchart will be updated shortly.
<img src="https://raw.githubusercontent.com/ccodwg/Covid19CanadaBot/main/docs/flowcharts/flowchart_ccodwg_update.png" alt="Flowchart illustrating the update process for CovidTimelineCanada" width="60%" height="60%">

### Flowchart for `Covid19CanadaArchive`

Expand Down
45 changes: 25 additions & 20 deletions docs/flowcharts/flowchart-ccodwg-update.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,36 @@ source("flowchart-funs.R")

# define flowchart
flowchart_ccodwg_update <- grViz('digraph flowchart {
graph [layout = dot, fontsize = 20, label = "\nBlue boxes indicate an automated step. Red boxes indicate a manual step."]
graph [layout = dot, fontsize = 20, label = <<br/>Blue boxes indicate an automated step. Red boxes indicate a manual step.<br/>All functions refer to the package <i>Covid19CanadaETL</i>.>]
# node definitions and labels
node [fontname = Helvetica, shape = rectangle, penwidth = 4]
data_computer [color = grey, label = "Machine-readable data"]
data_manual [color = grey, label = "Non-machine-readable data"]
etl [color = blue, label = <Automated data downloading and <br/>processing via <i>Covid19CanadaETL</i>>]
manual_entry [color = red, label = "Manual data entry"]
google_sheets [color = grey, label = "Data spreadsheets\n(Google Sheets)"]
verify_manual_data [color = blue, label = <Verify manual data have been entered<br/><i>(verify_manual_data.R)</i>>]
verify_data_sources [color = blue, label = <Periodic automated verification<br/>for missing/erroneous data<br/><i>(verify_data_sources.R)</i>>]
manual_correction [color = red, label = "Review automated notifications and\nmanually correct data (if necessary)"]
prepare_update [color = blue, label = <Prepare data update<br/><i>(update_data.R)</i>>]
update_summary [color = blue, label = <Automated summary of update<br/><i>(update_data_validation_funs.R)</i>>]
prepare_update_official [color = blue, label = <Add official datasets to data update<br/><i>(update_official_data.R)</i>>]
update_github [color = blue, label = "Push data update to GitHub (22:00 ET)"]
update_gdrive [color = blue, label = "Sync updated data files to Google Drive"]
data_active_ts [color = grey, label = "Active time series data"]
data_active_cumul [color = grey, label = "Active cumulative data"]
data_reports [color = grey, label = "Reports data"]
data_covid19tracker [color = grey, label = "covid19tracker.ca data"]
data_static [color = grey, label = "Static datasets"]
update_active_ts [color = blue, label = <Download and process<br/>(<i>update_active_ts</i>)>]
update_active_cumul [color = blue, label = <Upload to Google Sheets<br/>(<i>update_active_cumul</i>)>]
update_reports [color = red, label = <Manual entry into<br/>Google Sheets>]
update_covid19tracker [color = blue, label = <Download and process<br/>(<i>update_covid19tracker</i>)>]
update_raw_datasets [color = blue, label = <Update raw datasets<br/>(<i>update_raw_datasets</i>)>]
assemble_final_datasets [color = blue, label = <Assemble final datasets<br/>(<i>assemble_final_datasets</i>)>]
diff_datasets [color = blue, label = <Calculate dataset diffs<br/>(<i>diff_datasets</i>)>]
push_data [color = blue, label = "Push dataset to GitHub"]
email_log [color = blue, label = "Email log of errors (if any)"]
review_log [color = red, label = "Review error log and correct issues"]
# edge definitions with the node IDs
data_computer -> etl -> google_sheets
data_manual -> manual_entry -> google_sheets
manual_entry -> verify_manual_data
google_sheets -> verify_data_sources -> manual_correction
google_sheets -> prepare_update -> update_summary -> manual_correction
prepare_update_official -> prepare_update -> update_github -> update_gdrive
data_active_ts -> update_active_ts -> update_raw_datasets
data_active_cumul -> update_active_cumul -> update_raw_datasets
data_reports -> update_reports -> update_raw_datasets
data_covid19tracker -> update_covid19tracker -> update_raw_datasets
update_raw_datasets -> assemble_final_datasets
data_static -> assemble_final_datasets
assemble_final_datasets -> diff_datasets
diff_datasets -> push_data
diff_datasets -> email_log -> review_log
}')

Expand Down
Binary file modified docs/flowcharts/flowchart_ccodwg_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 08fe5e8

Please sign in to comment.