UCSBCarpentry / Reproducible-Publications-with-RStudio-Quarto

Introduction to Reproducible Publications with Quarto
https://UCSBCarpentry.github.io/Reproducible-Publications-with-RStudio-Quarto/
Other
8 stars 10 forks source link

Episode 4 Getting Your project set up with Version Control in RStudio - project Type screen #128

Closed ilessing closed 9 months ago

ilessing commented 10 months ago

Recent version of R studio has a screen in the New Project Wizard where you choose a project type.

This needs to be incorporated into the lesson.

Should user choose the first option: New R Project

or

Quarto Project?

02-rstudio-project-type
rcurty commented 10 months ago

We are creating a project from version control, not need to select the quarto option.

rcurty commented 10 months ago

Add content to mention quarto projects before we cover the project yaml for relative paths.

See: https://quarto.org/docs/projects/quarto-projects.html

rcurty commented 9 months ago

Discuss placement. Should we add this when learners are asked to create their first qmd "my-first-qmd", and instead ask them to create a quarto project, so that we can cover the files and settings?

torwhite commented 9 months ago

That could work! But let's make sure not to over-burden learners at that beginning stage.

ilessing commented 9 months ago

suggested in meeting today:

tell learners that you can still make Quarto documents inside a generic Rstudio project OR in a Quarto Project. It is not necessary to create a Quarto project to use Quarto documents in your project.

Since we are not having learners create a brand new project from scratch they do NOT have to make the choice about project type during the workshop. For this reason we can cover Quarto project topics like the Project YAML (_quarto.yml) in later episode/advanced topics.

rcurty commented 9 months ago

Suggestion for placement: at the end of episode https://ucsbcarpentry.github.io/Reproducible-Publications-with-RStudio-Quarto/02-Quarto/02-setup-versioning/index.html to cause less disruption.

A note on Quarto projects: When initiating a new project, you have the option to open a Quarto project, as illustrated in the image below (add fig). Regardless of your choice, you can create new Quarto documents within R projects, Quarto projects, or even outside projects at any time. You may be curious about the distinctions and advantages of using Quarto Projects. Quarto projects offer efficient file rendering within a directory, support shared YAML configuration across documents, and provide flexibility in redirecting outputs to a specified directory. Every Quarto project includes a "_quarto.yml" configuration file, ensuring that any document rendered within the project directory automatically inherits the metadata defined at the project level. However, there's no need to worry about this now. Let's focus on the basics first, and we'll explore more advanced features of Quarto projects later on.

torwhite commented 9 months ago

I think that the note on Quarto projects should be in the "Method #1" section (though perhaps a callout at the end of that section) rather than at the end of the episode. The screenshot of the project menu needs to be added to Method 1 instructions regardless and adding the note at the end would require adding the figure twice.

Edit to the note:

"When initiating a new project, you are presented with a large variety of project options from a generic “New Project” (aka R Project) to a variety of Quarto projects as seen in the image above (add fig). Regardless of your choice at this step, you can create new Quarto documents within R projects, Quarto projects, or even outside projects at any time. You may also convert an R project to a Quarto project and back at any point as well.

However, there's no need to worry too much about this now. Let's focus on the basics first, and we'll explore more advanced features of Quarto projects in a later episode."

I don't think we need to mention the "_quarto.yml" file at this point. I will do a callback to this menu when I introduce Quarto projects in the Advanced episode and introduce/expand on "_quarto.yml" then

rcurty commented 9 months ago

Please see changes: https://github.com/UCSBCarpentry/Reproducible-Publications-with-RStudio-Quarto/commit/237170758abe84f0bafcd3a21bc64c946046e074. I made a few tweaks to help with the flow.

torwhite commented 9 months ago

There seems to be an issues with the page because it's not rendering properly for me - just a giant block of text!

rcurty commented 9 months ago

9c29129

rcurty commented 9 months ago

Closing this after creating a new issue specifying required actions: Reorg Git/GitHub content #148