Course materials structure

Course lessons content

A module is a set of lessons within a course. Modules are defined by the

• module-title - What appears at the top fo the page as the title
• module-nav-title - What appears on the SIDE bar to group multiple lessons together
• module-description - what describes the entire lesson set and is rendered at the top of the page

module-title: 'Link data, processing and results using R Markdown and knitr'
module-nav-title: 'R Markdown Intro'
module-description: 'This module reviews how to use R Markdown

module-type: 'class'

Class order is the order of the MODULE within a section of the class. This allows any particular week to have more than one set of lessons associated with it.

class-order: 3

Any course needs a course name. The course: yaml is what binds all course materials to one course

course: "earth-analytics"

I need to look up how week number is being used. i think it does order a module set to a particular week but i'm not certain as the class-lesson should do that??

week: 1

The order element refers to the order in which the lessons render within a particular module set. The first lesson in a set order:1 needs to have a module title and description associated with it. All other lessons don't need that.

order: 1

sidebar: nav: author_profile: false comments: true

Course content that will not be a part of the "lessons" that are cataloged on lesson pages will be flagged with

module-type: 'overview'

To ensure a sidebar populates on a course landing page - currently we need to require the following code:

sidebar:
  nav:

Each course page requires a course slug which populates the correct left hand side bar. Alllesson

course: "earth-analytics"

Overview materials

Overview materials are the logistic elements of the course. We don't want them to be included in our numeric counts of lessons as they are often syllabi, assignment pages, etc. Thus they will have the tag

overview-order: 1

Which will be used to order them correctly on the left hand side bar. However this tag will allow us to filter them out from the lists of course modules which contain lessons.

and knitr to create and publish dynamic reports that both link analysis, results and documentation and can be easily updated as data and methods are modified / updates.'

topics: reproducible-science-and-programming: ['rmarkdown']