Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full draft of ep 4 (and rough draft of ep 5) #95

Merged
merged 21 commits into from
Dec 31, 2024

Conversation

kaijagahm
Copy link
Collaborator

@xortizross @peterlaurin

Re-drafted the reproducible code episode.

  • simplified the road map
  • incorporated the email correspondence format that @xortizross liked from the draft
  • deleted the draft
  • exercises still need work, and there's a lot of dithering/questions included.

Created a really really rough draft of the "asking your question" episode. Organization/flow of that one needs some help but I wanted to brain dump.

This content is ready for review (and it really needs it!!!)

Copy link

github-actions bot commented Dec 29, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries-incubator/R-help-reprexes/compare/md-outputs..md-outputs-PR-95

The following changes were observed in the rendered markdown documents:

 1-intro-reproducible-examples.md |    2 +-
 3-minimal-reproducible-data.md   |   58 +-
 4-minimal-reproducible-code.md   |  923 ++++++++++++++++++++++++--------
 5-asking-your-question.md        |  447 +++++++++++++++-
 config.yaml (gone)               |   81 ---
 fig/custom_function.png (new)    |  Bin 0 -> 213664 bytes
 md5sum.txt                       |   30 +-
 renv.lock (gone)                 | 1092 --------------------------------------
 setup.md                         |    4 +-
 9 files changed, 1180 insertions(+), 1457 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-12-31 21:57:27 +0000

@kaijagahm kaijagahm changed the title Accept xor changes ep4 Full draft of ep 4 (and rough draft of ep 5) Dec 29, 2024
github-actions bot pushed a commit that referenced this pull request Dec 29, 2024
@kaijagahm kaijagahm added episode:reproducible code Issues related to episode 5. Minimal Reproducible Code episode:asking questions Issues related to episode 6. Asking your question labels Dec 29, 2024
peterlaurin
peterlaurin previously approved these changes Dec 31, 2024
@@ -21,7 +21,7 @@ exercises: 2
::::::::::::::::::::::::::::::::::::::::::::::::

#### Welcome and introductions
- Welcome to "RRRR, I'm Stuck!" We're glad you're here! Let's first take care of a few setup steps. You should have all followed the setup instructions on the [workshop website](kaijagahm.github.io/R-help-reprexes/), and you should have both R and RStudio installed.
- Welcome to "RRRR, I'm Stuck!" We're glad you're here! Let's first take care of a few setup steps. You should have all followed the setup instructions on the [workshop website](https://carpentries-incubator.github.io/R-help-reprexes/), and you should have both R and RStudio installed.

- You should also have the following packages installed: {**reprex**}, {**ratdat**}, {**dplyr**}, and {**ggplot2**}.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should probably add package versions or have an renv tie-in

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments on changes occuring previously to this pull request -- unfortunately I can't comment on the exact line :(

Line 9: How is the process of getting help in R different from getting help with other things?

I don't understand this question, and it seems somewhat vague... maybe "how can I get help with problems in my code?" and "Why are we covering R in this lesson?" Idk something along those lines?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 28:
"We have a range of levels of experience here. This workshop assumes that you are researcher in ecology/biology who has some prior experience working with R in RStudio."

How much are we assuming that? I think it's fine to just say "we are ecologists and will focus on a biological example, but this is applicable to many data scientists" -- unless we want an explicit carpentries' R Ecology connection?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to be very explicit with prior experience (e.g. "R skills from carpentries' R Ecology lesson" and also a bit of a verbal cheatsheet for places to skip to in case you have prior experience

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 58-69: Unsure of why these lines are in code blocks. They do show up a bit weirdly on the rendered markdown / website

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the idea of a diagram

- Which part of my code is causing the problem?
- Which parts of my code should I include in a minimal example?
- How can I tell whether a code snippet is reproducible or not?
- How can I make my code reproducible?
:::

::: objectives
- Explain the value of a minimal code snippet.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems a little vague and mostly redundant with previous objectives and later objectives?


table(rodents$taxa)
You're happy with the progress you've made in exploring your data, and you're excited to move on to your second research question: Do the k-rat exclusion plots actually exclude k-rats?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably describe krats more in depth in the intro, and make sure our predictions and tests are the simplest questions we can ask, just to not add too much to cognitive load


# Not very helpful. BUT
sum(is.na(rodents$taxa)) # sum considers T = 1 and F = 0
Prediction 1: If the k-rat plots work, then we would expect to see fewer k-rats in the k-rat exclusion plots than in the control, with the fewest in the long-term k-rat exclosure plot.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like prediction / hypothesis can intrinsically condition on 'working'.
How about "Prediction 1: Fewer k-rats occupy k-rat exclosure plots than control plots; Prediction 2: Fewer k-rats occupy long-term k-rat exclosure plots than either control or short-term exclosure plots"

rodents <- rodents %>%
filter(taxa == "Rodent")
glimpse(rodents)
Second, if the k-rat plots work, then we would expect a lower proportion of *spectabilis* in the *spectabilis*-specific exclosure than in the control plot, regardless of the absolute number of k-rats caught.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Prediction 3: A lower proportion of spectabilis occupy the spectabilis-specific exclosure than the control plot"

# If the k-rat plots work, then we would expect:
# A. Fewer k-rats overall in any of the exclusion plots than in the control, with the fewest in the long-term k-rat exclusion plot
```{r}
# Prediction 1: expect fewer k-rats in exclusion plots than in control plot
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, I guess it gets simplified down here

@peterlaurin peterlaurin self-requested a review December 31, 2024 21:57
github-actions bot pushed a commit that referenced this pull request Dec 31, 2024
@peterlaurin peterlaurin merged commit 4afb5eb into main Dec 31, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 31, 2024
Auto-generated via `{sandpaper}`
Source  : 4afb5eb
Branch  : main
Author  : peterlaurin <[email protected]>
Time    : 2024-12-31 21:58:11 +0000
Message : Merge pull request #95 from carpentries-incubator/accept-xor-changes-ep4

Full draft of ep 4 (and rough draft of ep 5)
github-actions bot pushed a commit that referenced this pull request Dec 31, 2024
Auto-generated via `{sandpaper}`
Source  : 7dd2930
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-12-31 22:00:42 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 4afb5eb
Branch  : main
Author  : peterlaurin <[email protected]>
Time    : 2024-12-31 21:58:11 +0000
Message : Merge pull request #95 from carpentries-incubator/accept-xor-changes-ep4

Full draft of ep 4 (and rough draft of ep 5)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
episode:asking questions Issues related to episode 6. Asking your question episode:reproducible code Issues related to episode 5. Minimal Reproducible Code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants