Documentation

[geohacker]

@hamishwp it would be great to add some docs to this repo around:

• Overall goals and process. Also list of data sources, links, frequency of updates
• Components (ETL, preprocessing, error handling, analytics products etc) — what each things/folders do, what output is expected
• How to run locally — also great if there's way to setup the env and install packages
• What's the easiest way to run a slice of the process
• Extending this code base to:
  • add a new dataset
  • modify attributes
• How this repo relates to the Monty-IFRC repo, how does one ingest new data?

cc @batpad anything else? @justinginnetti @LukeCaley

[geohacker]

I see for example https://github.com/IFRCGo/GCDB/blob/main/RCode/Setup/InstallationChecks.R#L11-L15 — links to files that I don't find in the repo.

[justinginnetti]

Thanks for creating the ticket, @geohacker

[geohacker]

I'm running through a flow to install packages by following Main.R -> Setup/GetPackages.R but looks like GetEnv.R is missing which is referred to in this line https://github.com/IFRCGo/GCDB/blob/main/RCode/Setup/GetPackages.R#L10