Ensure code can be run, add short documentation to README

rrwen · Jan 13, 2025 · 0c6d6c3 · 0c6d6c3
1 parent 86db6ba
commit 0c6d6c3
Show file tree

Hide file tree

Showing 25 changed files with 85 additions and 95 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,19 @@
 # Pedalling Forward: The Evolution of Dedicated Cycling Infrastructure in Canadian Cities from 2010 to 2022
 
-Konrad Samsel<sup>a,b</sup>, <konrad.samsel@mail.utoronto.ca>  
-Richard Wen<sup>a,b</sup>, <richard.wen@utoronto.ca>  
-Brice Batomen<sup>a</sup>, <brice.kuimi@utoronto.ca>  
-Linda Rothman<sup>b</sup>, <linda.rothman@torontomu.ca>  
-
-*<sup>a</sup> Dalla Lana School of Public Health, University of Toronto*  
-*<sup>b</sup> School of Occupational and Public Health, Toronto Metropolitan University*
-
 * [R Code for Figures and Tables](https://rrwen.github.io/recovr-infracycle/)
 * [CARSP 2024 Slides](https://github.com/rrwen/recovr-infracycle/blob/main/slides/wen-etal-2024-carsp-infracycle.pptx)
 
+To reproduce the figures and tables in the study, follow the instructions in the [R Code for Figures and Tables](https://rrwen.github.io/recovr-infracycle/).
+
+## Folder Structure
+
+* `data`: contains the raw and pre-processed data
+	* For a description of pre-processed data, see [data.csv](data/data.csv)
+	* Each data file ending in `-datadict` contains the data dictionary of column names and descriptions
+* `docs`: contains the HTML files for [R Code for Figures and Tables](https://rrwen.github.io/recovr-infracycle/)
+* `manuscript`: contains current and previous manuscripts along with figure image files
+* `slides`: contains presentation slides
+
 ## Contact
 
 Richard Wen <rrwen.dev@gmail.com> for any code or technical related issues.
diff --git a/data/README.md b/data/README.md
diff --git a/docs/index.html b/docs/index.html
diff --git a/...ture in Canadian Cities - Working V3.docx → ...ture in Canadian Cities - Working V3.docx b/...ture in Canadian Cities - Working V3.docx → ...ture in Canadian Cities - Working V3.docx
diff --git a/...ve/Infrastructure_Oct 25_24_LR_RW_BB.docx → ...ve/Infrastructure_Oct 25_24_LR_RW_BB.docx b/...ve/Infrastructure_Oct 25_24_LR_RW_BB.docx → ...ve/Infrastructure_Oct 25_24_LR_RW_BB.docx
diff --git a/...ve/Infrastructure_Oct 28_24 _2_AH_RW.docx → ...ve/Infrastructure_Oct 28_24 _2_AH_RW.docx b/...ve/Infrastructure_Oct 28_24 _2_AH_RW.docx → ...ve/Infrastructure_Oct 28_24 _2_AH_RW.docx
diff --git a/manuscript/figures/fig-maps.pdf b/manuscript/figures/fig-maps.pdf
diff --git a/manuscript/figures/fig-methods.pdf b/manuscript/figures/fig-methods.pdf
diff --git a/manuscript/figures/fig-yearly-change.pdf b/manuscript/figures/fig-yearly-change.pdf
diff --git a/manuscript/figures/fig-yearly-len.pdf b/manuscript/figures/fig-yearly-len.pdf
diff --git a/manuscript/figures/sfig-change-calg.pdf b/manuscript/figures/sfig-change-calg.pdf
diff --git a/manuscript/figures/sfig-change-toron.pdf b/manuscript/figures/sfig-change-toron.pdf
diff --git a/manuscript/figures/sfig-change-vanc.pdf b/manuscript/figures/sfig-change-vanc.pdf
diff --git a/manuscript/figures/sfig-compare-calg.pdf b/manuscript/figures/sfig-compare-calg.pdf
diff --git a/manuscript/figures/sfig-compare-toron.pdf b/manuscript/figures/sfig-compare-toron.pdf
diff --git a/manuscript/figures/sfig-compare-vanc.pdf b/manuscript/figures/sfig-compare-vanc.pdf
diff --git a/manuscript/figures/sfig-criteria-calg.pdf b/manuscript/figures/sfig-criteria-calg.pdf
diff --git a/manuscript/figures/sfig-criteria-toron.pdf b/manuscript/figures/sfig-criteria-toron.pdf
diff --git a/manuscript/figures/sfig-criteria-vanc.pdf b/manuscript/figures/sfig-criteria-vanc.pdf
diff --git a/manuscript/figures/sfig-map-calg.pdf b/manuscript/figures/sfig-map-calg.pdf
diff --git a/manuscript/figures/sfig-map-toron.pdf b/manuscript/figures/sfig-map-toron.pdf
diff --git a/manuscript/figures/sfig-map-vanc.pdf b/manuscript/figures/sfig-map-vanc.pdf
diff --git a/archive/check-remove-2024-10-31.R → src/archive/check-remove-2024-10-31.R b/archive/check-remove-2024-10-31.R → src/archive/check-remove-2024-10-31.R
diff --git a/archive/check-upgrades-2024-09-26.R → src/archive/check-upgrades-2024-09-26.R b/archive/check-upgrades-2024-09-26.R → src/archive/check-upgrades-2024-09-26.R
diff --git a/archive/check-verify-2024-09-27.R → src/archive/check-verify-2024-09-27.R b/archive/check-verify-2024-09-27.R → src/archive/check-verify-2024-09-27.R