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

Project paths #34

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Project paths #34

wants to merge 4 commits into from

Conversation

mitchelloharawild
Copy link
Collaborator

@mitchelloharawild mitchelloharawild commented Jan 14, 2025

Revised version based on the feedback in #17

  • Writing style in general for lessons? -- conversational explanation vs. step-by-step follow-along instructions?
    @mitchelloharawild: Make brief, less flowery remove motivation e.g. 'essential', 'vital', much less conversational and more instructional/direct.

  • For clarity, I'd suggest preferencing active voice and more consistent/explicit reference to sentence subject e.g.:
    Creating R Projects --> Create an R Project
    your analysis and its files --> your analysis files

  • It might be worth running the R Project section, especially the introduction, creating & using R project sections through LLM to break up sentences. File Paths section is short and sweet, easily and quick to read :)!
    @mitchelloharawild: mimic short sweet structure of file paths.

  • Maybe activate collapse option on callouts to allow users to hide them away (or maybe hide away some by default) and make the instructions/main content easier to skim.
    @mitchelloharawild: Keep default expanded callouts short (MAX 2 paragraphs).
    Notes e.g. folder can be collapsed by default. Generally tips and importants are expanded by default.

  • Jargon-ish language that some students might not understand: home directory, boilerplate, folders. This might not be an us problem though --- https://cseducators.stackexchange.com/questions/3535/introducing-file-systems-to-students-who-really-dont-understand

  • assumptions about skill for navigating folders and the hierarchical nature of it.

  • what is a working directory? (earlier? or hyperlink down to dedicated subsection)

  • explain home directory

  • add quiz to rproj

  • The section about "Here" should be extended with some recommendations/guidance on when/why here is useful- no unexplained side-eyes!

  • Make external paths follow the same structure as others

  • Consider lifting {here} into it's own subsection of "Project Paths".

Copy link
Collaborator

@cynthiahqy cynthiahqy left a comment

Choose a reason for hiding this comment

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

Readability edits

  • Edited workspace restoration & Organised structure are a bit.. slogan-y? so I edited them to be more informative about what/how it supports workflow.
  • Removed some "CS"-y language -- e.g. "root of..."
  • Fixed some incomplete cross-reference (e.g. my-awesome-project.Rproj: This is the R Project file, which we [created earlier](http://localhost:4200/modules/starter/project-structure/#sec-projects). but the R Project file was not previously mentioned/explained)
  • Explanations in the File Path section are really good, though I added a reference to the "R session", and it would be good to link this to a definition (see below).

Broader module discussion

  1. I can't find a definition of an "R session" anywhere in the other modules --- I think it probably belongs in RStudio basics? before R Basics?

  2. Where should further reading/outlinks go? -- at the end as "additional reading"/"If you're curious"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants