search

CIAT-DAPA / GapAnalysis

11 stars 9 forks source link

improve documention for loading full datasets(Ecoregions and protected areas) #16

Open dcarver1 opened 3 years ago

dcarver1 commented 3 years ago

The GetDatasets() funcitons stores downloads files into a specific repo.

Currently, all functions will pull the worldwide ecoregion and protected areas file if those parameters are kept blank.

How every if someone want to put to those files directly, there is not any documentation to tell them look in system.file("data/preloaded_data/ecoRegion/tnc_terr_ecoregions.shp",package = "GapAnalysis")

I'm not sure how to best work this into the process, but we should try to make it more clear to users.

dcarver1 commented 3 years ago

I added additional information to the readme on how to pull these datasets. I'll review again but I believe this should cover it this issue.

The only addition that might be worth showing is that if you leave these parameters null the package automatically looks for the files in the system.file() directory. This is noted in the function descriptions, so it seems a little redundant to add an example about it, but we can. @ColinKhoury @ccsosa Do you guys think it is worth adding?

ColinKhoury commented 3 years ago

Great. Yes, probably worth being clear wherever needed, even if being somewhat redundant