Urban-Analytics / RAMP-UA

https://urban-analytics.github.io/RAMP-UA/
MIT License
15 stars 10 forks source link

Documentation for the functions and parameters used in the R package #280

Closed spoonerf closed 3 years ago

spoonerf commented 3 years ago

Not really sure if I've done this right and could probably be more comprehensive, but thought I would put it here to get your feedback @Sparrow0hawk

codecov[bot] commented 3 years ago

Codecov Report

Merging #280 (197cfd1) into master (45ddd28) will decrease coverage by 0.10%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #280      +/-   ##
==========================================
- Coverage   45.04%   44.94%   -0.11%     
==========================================
  Files          22       22              
  Lines        2848     2848              
==========================================
- Hits         1283     1280       -3     
- Misses       1565     1568       +3     
Impacted Files Coverage Δ
microsim/population_initialisation.py 90.98% <0.00%> (-0.85%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 45ddd28...197cfd1. Read the comment docs.

Sparrow0hawk commented 3 years ago

This looks good @spoonerf ! I'm going to merge your changes into my own branch which contains a number of other documentation fixes which i'll then merge into master.