Update readme #20
Merged
Update readme #20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stufield
reviewed
Nov 1, 2023
There was a problem hiding this comment.
Minor comments. Looks good! Still unsure what to do with patchwork. It seems to get the margins a little better than grid.arrange().
Another option ... since this is just the README, is to simply hide ALL the code and use patchwork under the hood invisibly. The README is supposed to only highlight the functionality, and how to install, etc. Not necessarily go into coding detail. So perhaps consider using more description in the text, and revealing only the code you want to use to illustrate your point. The vignettes could be used for more detail about code, and we could link to the vignettes in the README. Just a thought 🤔
amanda-hi
force-pushed
the
update-readme
branch
4 times, most recently
from
ae9f074 to
c7cb065
Compare
stufield
approved these changes
Nov 3, 2023
- replaced all instances of patchwork (in vignettes) with gridExtra and added gridExtra to 'Suggests' in the DESCRIPTION file - gridExtra has less dependencies and is familiar, stable, and commonly used in R plotting packages - made minor verbiage modifications to README - added details to plot table in README - updated WORDLIST to accomodate terms used in new README plot table - fixes #19
amanda-hi
force-pushed
the
update-readme
branch
from
c7cb065 to
0edb645
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview of Pull Request
General description of the purpose for this pull request ...
Fixes #19
Main changes
patchworkpackage w/gridExtraChange type
Please check the relevant box(es):
Choose reviewer(s)
Reviewer by Department