Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KatherineCox authored Nov 27, 2024
1 parent 799c6c4 commit ee92b80
Showing 1 changed file with 6 additions and 36 deletions.
42 changes: 6 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,18 @@
<!--Delete this section below upon using the template-->

## AnVIL Template

Based on [_Open-source Tools for Training Resources (OTTR)_](https://github.com/jhudsl/OTTR_Template)

The purpose of this template and is to make publishing maintenance for AnVIL content across multiple different platforms _less painful_.

_This template helps you_:

- Edit and write an AnVIL course in [RMarkdown files](https://rmarkdown.rstudio.com/) and have it published to multiple different platforms:
- [Leanpub](https://leanpub.com/bookstore?type=course)
- [Bookdown](https://bookdown.org/)
- [Coursera](https://www.coursera.org/)
- Have [Github action robots](https://github.com/jhudsl/OTTR_Template/wiki/How-to-set-up-and-customize-GitHub-actions-robots) do your repetitive tasks like spell check and re-rendering.
- Use [automagic conversion](https://github.com/jhudsl/ottrpal) to ease the lift of prepping the material for different platforms' formats.
- Use [our Docker image](https://hub.docker.com/repository/docker/jhudsl/course_template) for consistency across authors as well as to help you [avoid dependency hell](https://en.wikipedia.org/wiki/Dependency_hell).

<img src="https://docs.google.com/presentation/d/18k_QN7l6zqZQXoiRfKWzcYFXNXJJEo6j4daYGoc3UcU/export/png?id=18k_QN7l6zqZQXoiRfKWzcYFXNXJJEo6j4daYGoc3UcU&pageid=gf4fcf6569c_2_29" width="500"/>

## To Get Started
- Go to [ottrproject.org](https://www.ottrproject.org/).
- Please take a look at the [code of conduct](./code_of_conduct.md).
- If you encounter any problems or have improvement ideas for this template repository, please [file an issue](https://github.com/jhudsl/AnVIL_bookdown_style/issues/new/choose)! Issues for the parent repository (the OTTR template repository) are also very much appreciated and can be submitted [here](https://github.com/jhudsl/OTTR_Template/issues/new/choose).

<!--Delete everything above this line upon using the template-->

# {Course Name}
# AnVIL Champions Guide

[![Render Bookdown and Coursera](https://github.com/jhudsl/OTTR_Template/actions/workflows/render-all.yml/badge.svg)](https://github.com/jhudsl/OTTR_Template/actions/workflows/render-all.yml)

This course was created from [the AnVIL Template](https://github.com/jhudsl/AnVIL_bookdown_style), which is based on [the OTTR Template](https://github.com/jhudsl/OTTR_Template)

You can see the rendered course material here: {Link to rendered bookdown and/or to the Leanpub. Will look something like: https://jhudatascience.org/{Course_Name}}

## About this course
You can see the rendered course material here: https://jhudatascience.org/AnVIL_Book_Champions/

This course introduces {info on what this course introduces}
## About this book

## Learning Objectives
This “booklet” is part of a series of books for the Genomic Data Science Analysis, Visualization, and Informatics Lab-space (AnVIL) of the National Human Genome Research Institute (NHGRI). This short booklet explains what AnVIL Champions are and serves as a resource for AnVIL Champions as they support their community.

This course will teach learners to:
Learn more about AnVIL by visiting https://anvilproject.org or reading the [article in Cell Genomics](https://www.sciencedirect.com/science/article/pii/S2666979X21001063).

- {You can use https://www.bobpikegroup.com/trainer-blog/5-steps-to-writing-clear-and-measurable-learning-objectives to define some learning objectives here}
- {More learning objectives}
Please check out our full collection of AnVIL and related resources: https://hutchdatascience.org/AnVIL_Collection/

## Encountering problems?

Expand Down

0 comments on commit ee92b80

Please sign in to comment.