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

Add Project Structure & File Paths #17

Open
tsat0002 opened this issue Jun 21, 2024 · 7 comments
Open

Add Project Structure & File Paths #17

tsat0002 opened this issue Jun 21, 2024 · 7 comments
Assignees
Labels
content Add or Update Modules

Comments

@tsat0002
Copy link
Collaborator

tsat0002 commented Jun 21, 2024

Aims & Objectives

These module(s) provide an introduction to project structure, file paths and importing data

By the end of these modules, learners should be able to

  • objective 1 teach basic project structure and good practice of project management in R
  • objective 2 teach how to import data from different sources (CSV files, excel files, files hosted online)

References/Inspiration

Format

  1. Organising your files
  2. Here package
  3. R project
  4. Different file types
  5. Importing data into R (with online sources)
  6. Exporting data from R

Two modules
First modules - files structure covers 1, 2, 3
Second modules - importing & exporting covers 4, 5, 6

@tsat0002 tsat0002 added the content Add or Update Modules label Jun 21, 2024
@tsat0002 tsat0002 self-assigned this Jun 21, 2024
@KrisanatA KrisanatA assigned KrisanatA and unassigned tsat0002 Jul 11, 2024
@cynthiahqy cynthiahqy added this to the 2025 Feb Launch milestone Dec 17, 2024
@cynthiahqy
Copy link
Collaborator

Finalised content -- except missing reference to web-paths (e.g. website.com/file.csv) -- but DONE FOR NOW! YAYYYY! #29

@mitchelloharawild
Copy link
Collaborator

Finished in 13a19e8

@cynthiahqy
Copy link
Collaborator

cynthiahqy commented Jan 10, 2025

  1. 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.
  2. 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
  3. 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.
  4. 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.
  5. 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

@mitchelloharawild Additional:

  • assumptions about skill for navigating folders and the hierarchical nature of it.
  • what is a working directory? (earlier? or hyperlink down to dedicated subsection)
  • home directory
  • rework 'boilerplate' (i.e. remove)
  • add quiz to rproj

@cynthiahqy cynthiahqy reopened this Jan 10, 2025
@cynthiahqy
Copy link
Collaborator

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

@mitchelloharawild
Copy link
Collaborator

Make sure the importance of 'portability' is clearly stated

@mitchelloharawild
Copy link
Collaborator

mitchelloharawild commented Jan 11, 2025

  • Make external paths follow the same structure as others

@mitchelloharawild
Copy link
Collaborator

mitchelloharawild commented Jan 11, 2025

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

@mitchelloharawild mitchelloharawild mentioned this issue Jan 14, 2025
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Add or Update Modules
Projects
None yet
Development

No branches or pull requests

4 participants