search

datacarpentry / R-ecology-lesson

Data Analysis and Visualization in R for Ecologists
https://datacarpentry.org/R-ecology-lesson/
Other
314 stars 508 forks source link

Restore code-handout.R to workbench lesson #869

Closed wood-chris closed 1 year ago

wood-chris commented 1 year ago

Step 5 in the 00-before-we-start lesson says:

Download the code handout, place it in your working directory and rename it (e.g., data-carpentry-script.R).

The "code handout" link is to https://datacarpentry.org/R-ecology-lesson/code-handout.R, which is in the legacy/gh-pages branch but not in the current main branch. I have copied this file to main.

However, I do note that main does contain a file called make_code_handout.R - it's not clear to me if this is the file that's meant to be downloaded instead (and if so, please reject my PR and the link can simply be fixed instead :) )

github-actions[bot] commented 1 year ago

:ok: Pre-flight checks passed :smiley:

This pull request has been checked and contains no modified workflow files, spoofing, or invalid commits.

It should be safe to Approve and Run the workflows that need maintainer approval.

zkamvar commented 1 year ago

Hi @wood-chris,

I apologise for the confusion. The solution is to fix the markdown text, not to add the code. The file is now at https://datacarpentry.org/R-ecology-lesson/files/code-handout.R

The Workbench generates the code handout automatically from the code that exists and so adding it in the main branch is not necessary. The make_code_handout.R file was written in a time when the tools to build the lesson lived inside this repository and should be removed. That was an oversight on my part during the lesson transition back in May.

cc: @datacarpentry/r-ecology-lesson-maintainers and @datacarpentry/r-ecology-lesson-maintainers-workbench

wood-chris commented 1 year ago

Hi @zkamvar!

Thanks for the explanation :) I'm curious now where the code-handout.R file actually lives (if it's now not generated by make_code_handout.R), I can't see it in the repo!

zkamvar commented 1 year ago

You don't see it because it's generated when the lesson is built, so it exists and is continually updated in the gh-pages branch (https://github.com/datacarpentry/R-ecology-lesson/blob/gh-pages/files/code-handout.R).

See https://carpentries.github.io/sandpaper-docs/deployment.html for more details.