|
| 1 | +# Workshop Title |
| 2 | + |
| 3 | +Authors: |
| 4 | + Author Name^[Institution], |
| 5 | + Another Author^[Another Institution]. |
| 6 | + <br/> |
| 7 | +Last modified: 14 May, 2018. |
| 8 | + |
| 9 | +## Overview |
| 10 | + |
| 11 | +### Description |
| 12 | + |
| 13 | +Along with the topic of your workshop, include how students can expect |
| 14 | +to spend their time. For the description may also include information |
| 15 | +about what type of workshop it is (e.g. instructor-led live demo, lab, |
| 16 | +lecture + lab, etc.). Instructors are strongly recommended to provide |
| 17 | +completely worked examples for lab sessions, and a set of stand-alone |
| 18 | +notes that can be read and understood outside of the workshop. |
| 19 | + |
| 20 | +### Pre-requisites |
| 21 | + |
| 22 | +List any workshop prerequisites, for example: |
| 23 | + |
| 24 | +* Basic knowledge of R syntax |
| 25 | +* Familiarity with the GenomicRanges class |
| 26 | +* Familiarity with xyz vignette (provide link) |
| 27 | + |
| 28 | +List relevant background reading for the workshop, including any |
| 29 | +theoretical background you expect students to have. |
| 30 | + |
| 31 | +* List any textbooks, papers, or other reading that students should be |
| 32 | + familiar with. Include direct links where possible. |
| 33 | + |
| 34 | +### Participation |
| 35 | + |
| 36 | +Describe how students will be expected to participate in the workshop. |
| 37 | + |
| 38 | +### _R_ / _Bioconductor_ packages used |
| 39 | + |
| 40 | +List any _R_ / _Bioconductor_ packages that will be explicitly covered. |
| 41 | + |
| 42 | +### Time outline |
| 43 | + |
| 44 | +An example for a 45-minute workshop: |
| 45 | + |
| 46 | +| Activity | Time | |
| 47 | +|------------------------------|------| |
| 48 | +| Packages | 15m | |
| 49 | +| Package Development | 15m | |
| 50 | +| Contributing to Bioconductor | 5m | |
| 51 | +| Best Practices | 10m | |
| 52 | + |
| 53 | +### Workshop goals and objectives |
| 54 | + |
| 55 | +List "big picture" student-centered workshop goals and learning |
| 56 | +objectives. Learning goals and objectives are related, but not the |
| 57 | +same thing. These goals and objectives will help some people to decide |
| 58 | +whether to attend the conference for training purposes, so please make |
| 59 | +these as precise and accurate as possible. |
| 60 | + |
| 61 | +*Learning goals* are high-level descriptions of what |
| 62 | +participants will learn and be able to do after the workshop is |
| 63 | +over. *Learning objectives*, on the other hand, describe in very |
| 64 | +specific and measurable terms specific skills or knowledge |
| 65 | +attained. The [Bloom's Taxonomy](#bloom) may be a useful framework |
| 66 | +for defining and describing your goals and objectives, although there |
| 67 | +are others. |
| 68 | + |
| 69 | +### Learning goals |
| 70 | + |
| 71 | +Some examples: |
| 72 | + |
| 73 | +* describe how to... |
| 74 | +* identify methods for... |
| 75 | +* understand the difference between... |
| 76 | + |
| 77 | +### Learning objectives |
| 78 | + |
| 79 | +* analyze xyz data to produce... |
| 80 | +* create xyz plots |
| 81 | +* evaluate xyz data for artifacts |
| 82 | + |
| 83 | +## Workshop |
| 84 | + |
| 85 | +Divide the workshop into sections (`## A Section`). Include |
| 86 | +fully-evaluated _R_ code chunks. Develop exercises and solutions, and |
| 87 | +anticipate that your audience will walk through the code with you, or |
| 88 | +work on the code idependently -- do not be too ambitious in the |
| 89 | +material that you present. |
0 commit comments