Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/griffithlab/pvactools_intro_course
Getting started with pVACtools - pVACseq, pVACbind and pVACview
https://github.com/griffithlab/pvactools_intro_course
Last synced: 2 days ago
JSON representation
Getting started with pVACtools - pVACseq, pVACbind and pVACview
- Host: GitHub
- URL: https://github.com/griffithlab/pvactools_intro_course
- Owner: griffithlab
- License: cc-by-4.0
- Created: 2023-04-24T15:49:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-17T20:01:31.000Z (about 2 months ago)
- Last Synced: 2024-09-18T00:40:05.915Z (about 2 months ago)
- Language: CSS
- Size: 101 MB
- Stars: 0
- Watchers: 13
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# Introduction to pVACtools
This course was created from [this GitHub template](https://github.com/jhudsl/OTTR_Template).
This course was created with Bookdown and introduces best practices and tools for neoantigen identification.
You can see the [bookdown rendered course material here (GitHub pages site)](https://griffithlab.github.io/pVACtools_Intro_Course/) or the [leanpub rendered version here](https://leanpub.com/c/intropvac).
## About this course
This course will introduce background concepts, tools, resources, and practical advice on designing cancer vaccines and prioritizing neoantigens with pVACtools.
## Learning Objectives
This course will teach learners to:
- Understand key concepts of neoantigen identification
- Install and run pVACtools
- Demonstrate pVACview
## Encountering problems?
If you are encountering any problems with this course, please file a GitHub issue or [contact us at pVACtools help](mailto:[email protected]).
## How to contribute to this course
There are extensive instructions available in the [OTTR documentation](https://www.ottrproject.org/index.html). Here are basic instructions/reminders:
1. Clone the repo.
2. Create and checkout a new branch.
3. Add new chapters by copying and modifying one of the existing Rmd chapter files. Add an appropriate entry in the `_bookdown.yml` file.
4. Add images to this [Google Slide deck](https://docs.google.com/presentation/d/1uz39zaObDGKhEVCGzO0JO35CTbC0oRAM0mxgLcMAA9Y/edit?usp=sharing), copy the slide link, and embed in chapters following example code in existing chapters.
5. Add references in BibTex format to the `book.bib` file. BibTex entries can be obtained with [doi2bib.org](https://www.doi2bib.org/). Cite references inline using `@key` where `key` is the citation key in the first line of the BibTex entry.
6. Once new/revised content is ready, commit and push from the branch, and create a pull request.
7. Go to [pull requests](https://github.com/griffithlab/pVACtools_Intro_Course/pulls) and make sure all checks passing.
8. Correct any reported errors. Any words incorrectly reported as spelling mistakes can be added to `resources/dictionary.txt`. Commit and push to re-run PR checks.
9. Have someone review and approve the pull request.
10. Merge the PR and delete the branch.
11. Make sure all build [Actions](https://github.com/griffithlab/pVACtools_Intro_Course/actions) complete successfully.
12. Review the bookdown build at [github pages site](https://griffithlab.github.io/pVACtools_Intro_Course/index.html).
13. Have the leanpub course admin Preview and then Publish a new version of the course.
All materials in this course are licensed under a Creative Commons Attribution 4.0 International License unless noted otherwise.