datacarpentry / r-intro-geospatial

Introduction to R for Geospatial Data
https://datacarpentry.org/r-intro-geospatial/
Other
47 stars 71 forks source link

Added missing curly braces in 02-project-intro.Rmd #129

Closed lquayle88 closed 1 year ago

mikemahoney218 commented 1 year ago

I'm curious what this will actually return -- I think it's often some crazy temporary directory path, though I don't actually know our CI well enough to know that without seeing it.

Do we think seeing a different path will confuse learners? Alternatively, might we consider also changing the text right after this box to something like Your working directory will be different from this one! On your computer, this should return a path like your/path/r-geospatial instead.

jsta commented 1 year ago

@mikemahoney218 The following line reads R should return your/path/r-geospatial as the working directory. Makes me wonder if the curly braces were left off on purpose to avoid confusion.

lquayle88 commented 1 year ago

@mikemahoney218 if you just run getwd() it returns the path to your home directory. Given that the preceding instructions create a new r-geospatial project, running getwd() returns the full path to that new project top-level. The following line therefore makes total sense. As to whether the missing curly braces were intentional 🤷

mikemahoney218 commented 1 year ago

Yeah, this strikes me as probably being intentional, considering that the home directory on a GitHub Actions runner won't correspond to the learner's file system (Google suggests it was /home/runner/work/<repo>/<repo> two years ago, but it's not in the docs anywhere I can see so is probably liable to change), and we have the text immediately after saying what the command should return.

Thank you very much for the PR! But I think in order to minimize learner confusion, it's probably best to keep this without the brackets for the moment being.