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

Adds figures to documentation and script to automatically update them as needed #83

Merged
merged 3 commits into from
Apr 22, 2019
Merged

Conversation

karissawhiting
Copy link
Collaborator

@karissawhiting karissawhiting commented Apr 22, 2019

Adds figures to docs and script to generate them. Does not update README figures yet. Figure sizes may need to be adjusted. Re: Issue #27

@ddsjoberg
Copy link
Owner

OMG this PR is so so amazing! I can't wait to review :)

@ddsjoberg ddsjoberg self-requested a review April 22, 2019 22:40
@ddsjoberg
Copy link
Owner

The tables look amazing! The code you wrote to create them is so short and easy to follow!

The checks all run without error/warning, and the help files all contain the amazing tables. A few initial thoughts (all of these can be addressed in a separate PR):

  1. The tables look especially nice on the {pkgdown} site :)
  2. I think we should shorten the tbl_summary table examples (and perhaps others). Also, two examples is should be sufficient (rather than the three we have). With fewer examples and shorter tables, the space between example code and the rest of the help file will be shorter. This requires no change before merging the pull request. We can make a separate issue to make these kinds of updates.
  3. Rather than call the section "Figures", perhaps we should call it "Example Output"? That may help people understand more easily that these are the output tables.
  4. Is there a way to make a separation between two example tables? Maybe an html break, <br>?
  5. This last one is a me issue I've had with {webshot}. When I try to run the code, I get an error. Do you know how to resolve it?

image

@ddsjoberg ddsjoberg merged commit 6571942 into ddsjoberg:dev Apr 22, 2019
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.

None yet

2 participants