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