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

New Course - Templates to Edit #2

Open
11 tasks
github-actions bot opened this issue Oct 1, 2021 · 0 comments
Open
11 tasks

New Course - Templates to Edit #2

github-actions bot opened this issue Oct 1, 2021 · 0 comments

Comments

@github-actions
Copy link

github-actions bot commented Oct 1, 2021

Follow the Wiki instructions here for details on how to complete the items in this issue.

The following files need to be edited to get this new course started!

If you are creating an ITCR course:

  • Delete _output.yml and index.Rmd files
  • Keep the _output-itcr.yml and index-itcr.Rmd files but delete the -itcr parts of those file names.

If you are creating any other courses:

  • Delete the _output-itcr.yml and index-itcr.Rmd files.

Files that need edited upon creating a new course.

  • README.md - Fill in all the { }.
  • index.Rmd - the author:, title:, and description: should be updated.
  • About.Rmd - Replace information with your own author information and change the course title in the yaml header!
  • 01-intro.Rmd - replace the information there with information pertinent to this new course.
  • 02-chapter_of_course.Rmd - This Rmd has examples of how to set things up, if you don't need it as a reference, it can be deleted.
  • code_output can be deleted if you don't plan to use code.

Files that need to be edited upon adding each new chapter (including upon creating a new course):

  • _bookdown.yml - The list of Rmd files that need to be rendered needs to be updated. See instructions.
  • book.bib - any citations need to be added. See instructions.

Files that need to be edited upon adding new packages that the book's code uses:

  • docker/Dockerfile needs to have the new package added so it will be installed. See instructions.
  • The code chunk in index.Rmd should be edited to add the new package.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

0 participants