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

Important modifications to be applied the Bookdown of Workshop 7 #59

Open
6 tasks done
linley-sherin opened this issue Jan 17, 2022 · 1 comment
Open
6 tasks done
Labels
enhancement New feature or request

Comments

@linley-sherin
Copy link
Contributor

linley-sherin commented Jan 17, 2022

Please read through the presenter and developer protocol for help with the GitHub workflow. For RMarkdown help, refer to our book template. R Markdown: The Definitive Guide is also a very helpful resource, and covers the tasks outlined below, including how to preview the book locally while you work.

  • Ensure that the material matches the presentation. The first priority for the book is that it matches any changes made to the presentation. The bookdown can and should have extra text so that participants can work through the material without help (i.e. the extra text should essentially fill the spot of a presenter, consider taking material from the presenter notes and adding it here).
  • Match code chunks to the presentation. Verify that all code shown in the presentation is present in the RMarkdown version. It is particularly important for the exercises (or challenges) to match the challenges in the presentations.
  • Add supporting images from the presentation to the RMarkdown (if they are missing). These images include any image that is not coded in the presentations, including diagrams to explain contents or methods in greater detail.
  • Verify the code. Verify that the code chunks work, and that relevant outputs (tables, figures, etc.) are being shown correctly in the book.
  • Verify the writing. Reading through the text to improve the grammar and syntax is greatly appreciated.
  • Ensure that both versions of the book match. Both languages should have identical books.
@linley-sherin linley-sherin added the enhancement New feature or request label Jan 17, 2022
@linley-sherin
Copy link
Contributor Author

  • Contributor section should be added (currently under construction) and updated to match README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant