project-gen3sis / R-package

Repository of the R-packageGen3sis
https://project-gen3sis.github.io/R-package/
GNU General Public License v3.0
29 stars 9 forks source link

Several vignettes are broken #69

Closed mmore500 closed 12 months ago

mmore500 commented 12 months ago

Opened #68 to fix the landscape design vignette.

It looks like the create input landscape vignette is broken too. The line https://github.com/project-gen3sis/R-package/blob/281183c89895429b2819c91082d2eeb3f85bd005/vignettes/create_input_landscape.Rmd#L61 depends on extdata/InputRasters, but these were removed in https://github.com/project-gen3sis/R-package/commit/504f02df3ae16bd70d19eebadce2bbf8028c28ca.

It looks like the vignettes are being tested as part of CI (e.g., https://github.com/project-gen3sis/R-package/actions/runs/7065249027/job/19234879787#step:7:19), but are passing because evaluation of some code blocks are disabled (e.g., {r eval=FALSE, message=F}). Is this intentional? If the vignettes are intended for general reference but not meant to be directly reproducible, a note to that effect at the top of the vignettes would be extremely helpful.

benj919 commented 12 months ago

Hi @mmore500

A first quick feedback on the this one. Most of the data files where moved to another project repo here: https://github.com/project-gen3sis/Simulations

From the vignette:

The landscape data as well as the input rasters are available at the [simulation repository]
(https://github.com/project-gen3sis/Simulations). Download these and define the correct path to it in order to continue.
[...]
datapath <- "data_from_project_gen3sis_simulations"
[...]
setwd(datapath)
temperature_brick <- brick("InputRasters/SouthAmerica/temperature_rasters.grd")

The chain of code here is theoretically correct, but only works on windows as it's path handling is case insensitive. It's inputRasters/... in the repo.

I'll check out your merge request another time.

cheers

mmore500 commented 12 months ago

Thanks @benj919, I'll take a look at the data there. :+1: