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

Vignette updates #170

Merged
merged 8 commits into from
Sep 22, 2023
Merged

Vignette updates #170

merged 8 commits into from
Sep 22, 2023

Conversation

tiffanymtang
Copy link
Collaborator

@tiffanymtang tiffanymtang commented Sep 22, 2023

Update vignettes:

  • Create short, introductory vignette
  • Move current long vignette into a "comprehensive simChef guide"

Close #160

@tiffanymtang tiffanymtang added the documentation Improvements or additions to documentation label Sep 22, 2023
Copy link
Contributor

@jpdunc23 jpdunc23 left a comment

Choose a reason for hiding this comment

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

Really huge improvements! Thanks so much for taking this on and doing such a lovely job.

I left some minor comments, none of which should block merging this PR. I haven't looked at the vignettes in the context of the pkgdown site, but we'll be able to see that once it's merged and can address any issues then, so feel free to merge when you have a moment.

Please remember to squash and merge.

Copy link
Contributor

Choose a reason for hiding this comment

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

Not critical, but any chance we can make this a pdf instead of png?

vignettes/cheat-sheet.Rmd Show resolved Hide resolved
vignettes/simChef.Rmd Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

You've definitely made some big improvements to the flow and readability of the this vignette.

Non-blocking for this PR, but do you think it would be possible to make this version build upon the simChef.Rmd rather than repeating what is already covered there? Then it would be a more advanced sequel rather than simply a more detailed version of the same, and hopefully we could cut it down a bit more. Something to think about but let's not worry about it for now.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, I think that would be good for the future. I was also thinking about whether or not to do this. I figured it could be beneficial to have another example for now. In the long-run, I think having (a) a separate collection of simChef examples plus (b) a comprehensive guide that builds on the introductory version would be ideal.

* missing quote
@tiffanymtang tiffanymtang merged commit 9d58deb into main Sep 22, 2023
5 of 6 checks passed
@tiffanymtang tiffanymtang deleted the vignette-updates branch September 22, 2023 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create tutorial vignette
2 participants