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

Mention Rproj file in lesson repo setup instructions #285

Merged
merged 2 commits into from
Sep 29, 2023

Conversation

tobyhodges
Copy link
Member

Fixes #182 by adding instruction to rename Rproj file

@github-actions
Copy link

github-actions bot commented Sep 28, 2023

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/lesson-development-training/compare/md-outputs..md-outputs-PR-285

The following changes were observed in the rendered markdown documents:

 infrastructure.md | 8 ++++++++
 md5sum.txt        | 2 +-
 2 files changed, 9 insertions(+), 1 deletion(-)
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 2023-09-29 10:33:16 +0000

github-actions bot pushed a commit that referenced this pull request Sep 28, 2023
@@ -168,6 +168,8 @@ These are:
We will address all of the files later in the training.
For now, we will move on to complete the basic setup of the lesson.


Copy link
Collaborator

Choose a reason for hiding this comment

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

Add .Rproj file to the list of repository files above - GitHub won't let me make suggestions to the above lines so leaving this as a comment.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm going to leave this out because I do not think that the Rproj file really fits the description of "accompanying files primarily intended for the repository itself rather than the lesson website" (nor is it exactly "intended for the lesson website" but instead lies somewhat ambiguously in-between.

Copy link
Collaborator

@anenadic anenadic Sep 29, 2023

Choose a reason for hiding this comment

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

Yes, I was wondering about that as well as was not sure if it was better to be consistent if not 100% correct as we mention this file under "Configuring a Lesson Repository" 🙈 😄 @tobyhodges .

Copy link
Collaborator

@anenadic anenadic left a comment

Choose a reason for hiding this comment

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

Great stuff @tobyhodges - some comments included.

Co-authored-by: Aleksandra Nenadic <[email protected]>
github-actions bot pushed a commit that referenced this pull request Sep 29, 2023
@tobyhodges tobyhodges merged commit a7f4f83 into main Sep 29, 2023
3 checks passed
github-actions bot pushed a commit that referenced this pull request Sep 29, 2023
Auto-generated via {sandpaper}
Source  : a7f4f83
Branch  : main
Author  : Toby Hodges <[email protected]>
Time    : 2023-09-29 10:35:37 +0000
Message : Merge pull request #285 from carpentries/182-rproj-fixme

Mention Rproj file in lesson repo setup instructions
github-actions bot pushed a commit that referenced this pull request Sep 29, 2023
Auto-generated via {sandpaper}
Source  : 1d59052
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-09-29 10:37:02 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : a7f4f83
Branch  : main
Author  : Toby Hodges <[email protected]>
Time    : 2023-09-29 10:35:37 +0000
Message : Merge pull request #285 from carpentries/182-rproj-fixme

Mention Rproj file in lesson repo setup instructions
@tobyhodges tobyhodges deleted the 182-rproj-fixme branch October 4, 2023 18:49
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.

address Rproj file in initial setup/config instructions
2 participants