Skip to content

Commit

Permalink
Merge pull request #32 from fhdsl/title-change
Browse files Browse the repository at this point in the history 
Title change, credits attribution
  • Loading branch information
@caalo
caalo authored Feb 29, 2024
2 parents ad4ee80 + bc7b77c commit 7a027d0
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 52 deletions.
61 changes: 18 additions & 43 deletions About.Rmd
View file
Original file line number Diff line number Diff line change
@@ -1,60 +1,34 @@

# About the Authors {-}
# About the Authors {.unnumbered}

These credits are based on our [course contributors table guidelines](https://www.ottrproject.org/more_features.html#giving-credits-to-contributors).

 
 


|Credits|Names|
|-------|-----|
|**Pedagogy**||
|Lead Content Instructor(s)|[FirstName LastName]|
|Lecturer(s) (include chapter name/link in parentheses if only for specific chapters) - make new line if more than one chapter involved| Delivered the course in some way - video or audio|
|Content Author(s) (include chapter name/link in parentheses if only for specific chapters) - make new line if more than one chapter involved | If any other authors besides lead instructor|
|Content Contributor(s) (include section name/link in parentheses) - make new line if more than one section involved| Wrote less than a chapter|
|Content Editor(s)/Reviewer(s) | Checked your content|
|Content Director(s) | Helped guide the content direction|
|Content Consultants (include chapter name/link in parentheses or word "General") - make new line if more than one chapter involved | Gave high level advice on content|
|Acknowledgments| Gave small assistance to content but not to the level of consulting |
|**Production**||
|Content Publisher(s)| Helped with publishing platform|
|Content Publishing Reviewer(s)| Reviewed overall content and aesthetics on publishing platform|
|**Technical**||
|Course Publishing Engineer(s)| Helped with the code for the technical aspects related to the specific course generation|
|Template Publishing Engineers|[Candace Savonen], [Carrie Wright], [Ava Hoffman]|
|Publishing Maintenance Engineer|[Candace Savonen]|
|Technical Publishing Stylists|[Carrie Wright], [Ava Hoffman], [Candace Savonen]|
|Package Developers ([ottrpal]) [Candace Savonen], [John Muschelli], [Carrie Wright]|
|**Art and Design**||
|Illustrator(s)| Created graphics for the course|
|Figure Artist(s)| Created figures/plots for course|
|Videographer(s)| Filmed videos|
|Videography Editor(s)| Edited film|
|Audiographer(s)| Recorded audio|
|Audiography Editor(s)| Edited audio recordings|
|**Funding**||
|Funder(s)| Institution/individual who funded course including grant number|
|Funding Staff| Staff members who help with funding|
| Credits | Names |
|------------------------------------------|------------------------------|
| Lead Content Instructor(s) | Aisling O'Farrell, Sitapriya Moorthi, Chris Lo |
| Content Editor(s)/Reviewer(s) | Amy Paguirigan, Carrie Wright, Ted Laderas |
| Content Director(s) | Amy Paguirigan |
| Content Consultants | Aisling O'Farrell |
| **Production** | |
| Content Publisher(s) | Carrie Wright |
| **Technical** | |
| Template Publishing Engineers | [Candace Savonen](https://www.cansavvy.com/), [Carrie Wright](https://carriewright11.github.io/), [Ava Hoffman](https://www.avahoffman.com/) |
| Publishing Maintenance Engineer | [Candace Savonen](https://www.cansavvy.com/) |
| Technical Publishing Stylists | [Carrie Wright](https://carriewright11.github.io/), [Ava Hoffman](https://www.avahoffman.com/), [Candace Savonen](https://www.cansavvy.com/) |
| Package Developers ([ottrpal](https://github.com/jhudsl/ottrpal)) [Candace Savonen](https://www.cansavvy.com/), [John Muschelli](https://johnmuschelli.com/), [Carrie Wright](https://carriewright11.github.io/) | |

 
 

```{r, echo = FALSE}
devtools::session_info()
```

<!-- Author information -->

[FirstName LastName]: link to personal website
[John Muschelli]: https://johnmuschelli.com/
[Candace Savonen]: https://www.cansavvy.com/
[Carrie Wright]: https://carriewright11.github.io/
[Ava Hoffman]: https://www.avahoffman.com/

<!-- Links -->

[ottrpal]: https://github.com/jhudsl/ottrpal

```{=html}
<!-- Fill out this table using these instructions: https://github.com/jhudsl/OTTR_Template/wiki/How-to-give-credits
For JHU courses, You will need to add Ira as a credit:
Expand All @@ -63,3 +37,4 @@ For JHU courses, You will need to add Ira as a credit:
...
[Ira Gooding]: https://publichealth.jhu.edu/faculty/4130/ira-gooding
-->
```
11 changes: 4 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
# {Course Name}
# Developing WDL Workflows

This course was created from [this GitHub template](https://github.com/jhudsl/OTTR_Template).

You can see the rendered course material here: {Link to rendered bookdown and/or to the Leanpub.}
You can see the rendered course material here: https://hutchdatascience.org/WDL_Workflows_Guide/

If you would like to contribute to this course material, take a look at the [OTTR documentation](https://www.ottrproject.org/).

## About this course

This course introduces {info on what this course introduces}
"Developing WDL Workflows" shows a bioinformatics workflow developer how to strategically develop and scale up a WDL workflow that is iterative, reproducible, and efficient in terms of time and resource used. This guide is flexible regardless of where the data is, what computing resources are being used, and what software is being used.

## Learning Objectives

This course will teach learners to:

- {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}
This course will teach learners to: how to write an effective WDL task, link multiple WDL tasks together in a workflow, organize variables via structs, scale multiple samples via Arrays, reuse repeated tasks via task aliasing, and configure settings for the execution engine.

## Encountering problems?

Expand Down
4 changes: 2 additions & 2 deletions index.Rmd
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "WDL Workflows Guide"
title: "Developing WDL Workflows"
date: "`r format(Sys.time(), '%B, %Y')`"
site: bookdown::bookdown_site
documentclass: book
Expand All @@ -15,7 +15,7 @@ output:

# About this Course {-}

This WDL workflow development guide shows a bioinformatics workflow developer how to strategically develop and scale up a WDL workflow that is iterative, reproducible, and efficient in terms of time and resource used. This guide is flexible regardless of where the data is, what computing resources are being used, and what software is being used.
"Developing WDL Workflows" shows a bioinformatics workflow developer how to strategically develop and scale up a WDL workflow that is iterative, reproducible, and efficient in terms of time and resource used. This guide is flexible regardless of where the data is, what computing resources are being used, and what software is being used.

## Target Audience

Expand Down

0 comments on commit 7a027d0

Please sign in to comment.