Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move learning_objective boiler plate to overview and feedback macros #927

Merged
merged 8 commits into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion _module_templates/macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

author: DART Team
email: [email protected]
version: 1.4.0
version: 1.4.1
current_version_description: Add text after Overview and Feedback that invites learners to the rest of the modules
language: en
narrator: UK English Female
Expand Down Expand Up @@ -35,6 +35,8 @@ Previous versions:

**Learning Objectives**

After completion of this module, learners will be able to:

@learning_objectives

**Version History**
Expand Down Expand Up @@ -71,6 +73,8 @@ In the beginning, we stated some goals.

**Learning Objectives:**

After completion of this module, learners will be able to:

@learning_objectives

We ask you to fill out a brief (5 minutes or less) survey to let us know:
Expand Down
3 changes: 1 addition & 2 deletions _module_templates/template_exercise.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ narrator: UK English Female
mode: Textbook

title: Module Title

comment: This is a short, focused description of the module.

long_description: This is a longer description, which should be understandable for a lay audience.
Expand All @@ -23,7 +22,7 @@ List any skills or knowledge needed to complete this module here.
@end

@learning_objectives
After completion of this module, learners will be able to:


- identify key elements
- create a product
Expand Down
2 changes: 1 addition & 1 deletion _module_templates/template_standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ List any skills or knowledge needed to complete this module here.
@end

@learning_objectives
After completion of this module, learners will be able to:


- identify key elements
- create a product
Expand Down
2 changes: 1 addition & 1 deletion _module_templates/template_wrapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ List any skills or knowledge needed to complete this module here.
@end

@learning_objectives
After completion of this module, learners will be able to:


- identify key elements
- create a product
Expand Down
5 changes: 1 addition & 4 deletions bash_103_combining_commands/bash_103_combining_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: bash_103_combining_commands
author: Elizabeth Drellich and Nicole Feldman
email: [email protected] and [email protected]
version: 1.4.4
version: 1.4.5
current_version_description: Added webinar links to additional resources; make liascript link(s) point to first page
module_type: standard
docs_version: 2.0.0
Expand All @@ -21,9 +21,6 @@ The only commands that will be assumed are the navigation commands `cd`, `ls`, a
@end

@learning_objectives

After completion of this module, learners will be able to:

- Use the commands `wc`, `head`, `tail`,`sort`, and `uniq`
- Redirect output to a file using `>` and `>>`
- Chain commands directly using the pipe `|`
Expand Down
4 changes: 1 addition & 3 deletions bash_command_line_101/bash_command_line_101.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: bash_command_line_101
author: Nicole Feldman and Elizabeth Drellich
email: [email protected] [email protected]
version: 1.5.6
version: 1.5.7
current_version_description: Updated metadata and macros; make liascript link(s) point to first page
module_type: standard
docs_version: 2.0.0
Expand All @@ -21,8 +21,6 @@ Learners should be familiar with [the command line interface](https://liascript.
@end

@learning_objectives
After completion of this module, learners will be able to:

- Describe what bash scripting is and why they might want to learn it for data management and research
- Navigate their file system using the bash shell
- View and edit the contents of a file from the bash shell
Expand Down
4 changes: 1 addition & 3 deletions bash_command_line_102/bash_command_line_102.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: bash_command_line_102
author: Nicole Feldman and Elizabeth Drellich
email: [email protected] and [email protected]
version: 1.3.3
version: 1.3.4
current_version_description: Add emphasis about the permanence of `rm`; make liascript link(s) point to first page
module_type: standard
docs_version: 3.0.0
Expand All @@ -19,8 +19,6 @@ Learners should be familiar with using a bash shell to navigate a directory syst
@end

@learning_objectives
After completion of this module, learners will be able to:

- Search existing files for particular character strings.
- Search folders for files with certain titles.
- Move files to new locations in a directory system.
Expand Down
4 changes: 2 additions & 2 deletions bash_conditionals_loops/bash_conditionals_loops.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: bash_conditionals_loops
author: Elizabeth Drellich
email: [email protected]
version: 1.2.6
version: 1.2.7
current_version_description: Clarify `=` and `==` inside test functions; make liascript link(s) point to first page
module_type: standard
docs_version: 1.2.1
Expand All @@ -26,7 +26,7 @@ Only basic exposure to Bash is expected. The following is a list of actions and

@learning_objectives

After completion of this module, learners will be able to:


- Understand how a "for loop" works
- Write a "for loop" in Bash
Expand Down
5 changes: 1 addition & 4 deletions bash_scripts/bash_scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: bash_scripts
author: Elizabeth Drellich
email: [email protected]
version: 1.3.4
version: 1.3.5
current_version_description: Added webinar links to additional resources; make liascript link(s) point to first page
module_type: standard
docs_version: 2.0.0
Expand All @@ -28,9 +28,6 @@ Bash commands that will be used without explanation include:
@end

@learning_objectives

After completion of this module, learners will be able to:

- Identify the structure of a Bash script
- Run existing Bash scripts
- Write simple Bash scripts
Expand Down
4 changes: 2 additions & 2 deletions bias_variance_tradeoff/bias_variance_tradeoff.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: bias_variance_tradeoff
author: Rose Hartman
email: [email protected]
version: 1.0.2
version: 1.0.3
current_version_description: Initial version.
module_type: standard
docs_version: 1.1.0
Expand All @@ -26,7 +26,7 @@ It's fine if you don't know how to conduct a regression analysis, but you should
@end

@learning_objectives
After completion of this module, learners will be able to:


- define bias and variance as they apply to machine learning
- explain the bias-variance tradeoff
Expand Down
4 changes: 2 additions & 2 deletions citizen_science/citizen_science.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: citizen_science
author: Rose Hartman
email: [email protected]
version: 1.0.5
version: 1.0.6
current_version_description: Initial version.
module_type: standard
docs_version: 1.0.0
Expand All @@ -24,7 +24,7 @@ None.

@learning_objectives

After completion of this module, learners will be able to:


- list several ways members of the public can contribute to scientific projects
- recognize several different factors that motivate people to volunteer in citizen science
Expand Down
4 changes: 2 additions & 2 deletions data_management_basics/data_management_basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: data_management_basics
author: Ene Belleh
email: [email protected]
version: 1.1.5
version: 1.1.6
current_version_description: Fixed mermaidchart error that was causing diagram to not render; updated metadata; make liascript link(s) point to first page
module_type: standard
docs_version: 3.0.0
Expand All @@ -19,7 +19,7 @@ The only pre-requisite suggested for this module is experience working in resear

@learning_objectives

After completion of this module, learners will be able to:


- Define research data management
- Explain why data management forms an important part of the responsible conduct of research
Expand Down
4 changes: 1 addition & 3 deletions data_storage_models/data_storage_models.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: data_storage_models
author: Nicole Feldman
email: [email protected]
version: 1.1.6
version: 1.1.7
current_version_description: Updated quiz questions and metadata; make liascript link(s) point to first page
module_type: standard
docs_version: 2.0.0
Expand All @@ -20,8 +20,6 @@ None, this module is intended for all end users regardless of their technical sk

@learning_objectives

After completion of this module, learners will be able to:

- Identify and describe different data storage solutions
- Understand the benefits and the limitations of each covered storage solution
- Describe what computational tasks are best suited to the described data storage types
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: data_visualization_in_ggplot2
author: Rose Hartman
email: [email protected]
version: 1.4.8
version: 1.4.9
current_version_description: Updated with new metadata and to remove references to Binderhub; make liascript link(s) point to first page
module_type: standard
docs_version: 2.0.0
Expand Down Expand Up @@ -33,7 +33,7 @@ If you are brand new to R (or want a refresher) consider starting with [Intro to

@learning_objectives

After completion of this module, learners will be able to:


- use ggplot2 to create several common data visualizations
- customize some elements of a plot, and know where to look to learn how to customize others
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: data_visualization_in_open_source_software
author: Rose Hartman
email: [email protected]
version: 1.2.3
version: 1.2.4
current_version_description: Update highlight boxes, update front matter, replace text with macros.
module_type: standard
docs_version: 1.0.0
Expand All @@ -29,8 +29,6 @@ This module also assumes some basic familiarity with either R or python, but is

@learning_objectives

After completion of this module, learners will be able to:

- identify key elements in a plot that communicate information about the data
- describe the role ggplot2 and seaborn play in the R and python programming languages, respectively
- describe a typical data vizualization workflow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: data_visualization_in_seaborn
author: Rose Hartman
email: [email protected]
version: 1.4.1
version: 1.4.2
current_version_description: Add Python Basics series and Transform data with pandas as additional prerequisites; make liascript link(s) point to first page
module_type: standard
docs_version: 3.0.0
Expand Down Expand Up @@ -35,7 +35,7 @@ If you are brand new to python (or want a refresher) consider starting with [Dem

@learning_objectives

After completion of this module, learners will be able to:


- use seaborn to create several common data visualizations
- customize some elements of a plot, and know where to look to learn how to customize others
Expand Down
4 changes: 2 additions & 2 deletions database_normalization/database_normalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: database_normalization
author: Joy Payton
email: [email protected]
version: 1.0.7
version: 1.0.8
current_version_description: Initial Version.
module_type: standard
docs_version: 2.0.0
Expand All @@ -19,7 +19,7 @@ Learners should have experience working with data in tables. This could include
@end

@learning_objectives
After completion of this module, learners will be able to:


- Explain the significance of "one to many" data relationships and how these relationships affect data organization
- Describe how a normalized database is typically organized
Expand Down
4 changes: 2 additions & 2 deletions demystifying_apis/demystifying_apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: demystifying_api
author: Joy Payton
email: [email protected]
version: 1.0.1
version: 1.0.2
current_version_description: Initial version; make liascript link(s) point to first page
module_type: standard
docs_version: 4.0.0
Expand All @@ -19,7 +19,7 @@ No particular skills or experience are required for this module.
@end

@learning_objectives
After completion of this module, learners will be able to:


- Define the term *application programming interface* (API)
- Explain why APIs can be useful to biomedical researchers
Expand Down
4 changes: 2 additions & 2 deletions demystifying_command_line/demystifying_command_line.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: demystifying_command_line
author: Joy Payton
email: [email protected]
version: 1.0.2
version: 1.0.3
current_version_description: Add link to Demystifying APIs; make liascript link(s) point to first page
module_type: standard
docs_version: 4.0.0
Expand All @@ -19,7 +19,7 @@ No particular skills or experience are required for this module.
@end

@learning_objectives
After completion of this module, learners will be able to:


- Define the term *interface*
- Explain how a computer user interacts with a command line interface
Expand Down
4 changes: 2 additions & 2 deletions demystifying_containers/demystifying_containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: demystifying_containers
author: Meredith Lee
email: [email protected]
version: 1.0.3
version: 1.0.4
current_version_description: Initial version
module_type: standard
docs_version: 1.0.0
Expand All @@ -23,7 +23,7 @@ The module assumes no prior familiarity with containers and requires no coding e
@end

@learning_objectives
After completion of this module, learners will be able to:


- understand when it might be useful to use containers for research
- describe the basic concept of containerization
Expand Down
4 changes: 2 additions & 2 deletions demystifying_geospatial_data/demystifying_geospatial_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: demystifying_geospatial_data
author: Elizabeth Drellich
email: [email protected]
version: 1.2.1
version: 1.2.2
current_version_description: Improve hyperlink accessibility
module_type: standard
docs_version: 1.2.0
Expand All @@ -24,7 +24,7 @@ No prior knowledge or experience of geospatial data is required.

@learning_objectives

After completion of this module, learners will be able to:


- Define geospatial data
- Describe some of the benefits of using geospatial data
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
module_id: demystifying_large_language_models
author: Joy Payton
email: [email protected]
version: 1.0.5
version: 1.0.6
current_version_description: Initial version
module_type: standard
docs_version: 2.0.0
Expand All @@ -23,7 +23,7 @@ None.
@end

@learning_objectives
After completion of this module, learners will be able to:


- Define "large language model" (LLM)
- Give a brief description of n-grams and word vectors
Expand Down
Loading