search

FlukeAndFeather / jese4sci-FP

Final Project track of the jese4sci short course
0 stars 3 forks source link

draft of FP301 #11

Closed mcgoodman closed 2 years ago

mcgoodman commented 2 years ago

Here's a draft of FP301. It contains instructions for documenting code using Roxygen2 and for writing READMEs based on the rrtools template. There's an image referenced by FP301.md as well.

mcgoodman commented 2 years ago

Could you provide more specific suggestions? The issue you opened (#5 ) says:

"Document objects". Roxygen comments for all functions in R/ and objects in data/. Fill out rrtools README.Rmd template.

It seems that DOC102 does not provide instructions for filling out the rrtools README, so the material here doesn't entirely overlap with DOC102. Would you like me to substitute just the part where I describe a README, or the whole section?

As for Roxygen comments, referring students to DOC201 seemingly requires extra work of students who did not choose to complete the DOC path. Should I instead refer them to the relevant resources you have listed under "How to use roxygen" in the DOC201 instructions?

FlukeAndFeather commented 2 years ago

I see what you mean. However, for the FP track, I want to keep the instructions brief and trust students to figure it out/ask questions. The purpose of the final project is to apply techniques/concepts they learned in week 1 with less guidance. So my preference is to err on the side of fewer instructions and more iterative feedback, rather than more info up front.

If no one in the project group completed DOC201, then I think I want to either have one student in the group take that lesson in week 2 or have the group skip this step entirely. There's more material in this course than everyone will get through, so I'm ok with them skipping some parts of the final project. Better to learn fewer things thoroughly than more things quickly.

mcgoodman commented 2 years ago

Substituted the instructions from your other modules in!