Skip to content

Commit cfb4ce5

Browse files
committed
add readme rmd and knitted md file
1 parent b77e22a commit cfb4ce5

File tree

2 files changed

+136
-44
lines changed

2 files changed

+136
-44
lines changed

README.Rmd

+52-20
Original file line numberDiff line numberDiff line change
@@ -11,44 +11,76 @@ knitr::opts_chunk$set(
1111
)
1212
```
1313

14-
# tutorials
14+
# Epiverse-TRACE Tutorials Middle
1515

1616
<!-- badges: start -->
17-
[![](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
18-
[![Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
17+
[![](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
18+
[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
1919
<!-- badges: end -->
2020

21-
The goal of `tutorials` is to host tutorials for Outbreak analytics with R.
21+
Tutorials on real-time analysis and forecasting for outbreak analytics with R developed by the Epiverse-TRACE initiative. These tutorials are visible at: <https://epiverse-trace.github.io/tutorials-middle/>.
2222

23-
## Usage
24-
25-
> NOTE: The expected date for the deployment of the first set of tutorials is mid-November 2023.
26-
27-
Visualize this content as a webpage at <https://epiverse-trace.github.io/tutorials/>
28-
29-
To build the website locally, please refer to [the contributing guidelines](CONTRIBUTING.md).
23+
More information about Epiverse-TRACE learning material is available at: <https://epiverse-trace.github.io/learn.html>
3024

3125
## Contributing
3226

33-
Contributions are always welcome!
27+
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for contributing guidelines and details on how to get involved with this project. Please adhere to this project's [Code of Conduct](CODE_OF_CONDUCT.md).
3428

35-
See our [Contributing guide](CONTRIBUTING.md) for ways to get started.
29+
Also see the current list of [issues](https://github.com/epiverse-trace/tutorials-middle/issues) for ideas on how to contribute to this training curriculum.
3630

37-
Please adhere to this project's [Code of Conduct](CODE_OF_CONDUCT.md).
31+
To learn more about how this lesson site is built and how you can edit the pages, see the [Introduction to The Carpentries Workbench](https://carpentries.github.io/sandpaper-docs/).
3832

3933
<!-- ## Support -->
4034

4135
<!-- Please see our [Getting help guide](/.github/SUPPORT.md) for support. -->
4236

4337
## License
38+
Lesson content is published with a [CC-BY license](LICENSE.md).
39+
40+
## Maintainer(s)
41+
42+
Current maintainers of these tutorials are:
43+
44+
- [Andree Valle-Campos](https://github.com/avallecam/) (Content)
45+
- [Hugo Gruson](https://github.com/Bisaloo/) (Infrastructure)
46+
47+
<!--
48+
Former maintainers:
49+
50+
- [Andree Valle-Campos](https://github.com/avallecam/)
51+
52+
-->
53+
54+
<!--## Acknowledgements-->
4455

45-
Read the [License](LICENSE.md) of this tutorial.
56+
## Related
4657

47-
## Authors
58+
Epiverse-TRACE documentation:
4859

49-
- [@amanda-minter](https://github.com/amanda-minter/)
50-
- [@avallecam](https://github.com/avallecam/)
60+
+ [How-to guides](https://epiverse-trace.github.io/howto/): Reproducible recipes with concrete steps to solve specific Outbreak Analysis questions using multiple packages.
61+
+ [Reference manuals and vignettes](https://epiverse-trace.github.io/getting-started.html#epiverse-trace-packages): Package-specific usage guides and function examples, along with explanatory articles.
5162

52-
```{r,eval=FALSE,echo=FALSE}
53-
readCitationFile(file = file.path("inst", "CITATION"))
63+
Preliminary learning materials:
64+
65+
+ [Introductory R tutorials](https://appliedepi.org/resources/tutorials.html): Refresh your R knowledge with interactive online self-paced tutorials from the Applied Epi organization.
66+
+ [The Epidemiologist R Handbook](https://www.epirhandbook.com/en/index.html): Online book on basics, data management, epidemiological analysis, visualization, and reporting from the Applied Epi organization.
67+
68+
## Citation
69+
70+
See [CITATION.cff](CITATION.cff) for citation information, including a list of authors.
71+
([Read more about the Citation File Format and how to use it](https://citation-file-format.github.io/).)
72+
73+
To cite these tutorials in publications use:
74+
75+
```{r,eval=TRUE,echo=FALSE,comment=""}
76+
cffr::as_bibentry(x = "CITATION.cff")
5477
```
78+
79+
A BibTeX entry for LaTeX users is:
80+
81+
```{r,eval=TRUE,echo=FALSE,comment=""}
82+
utils::toBibtex(cffr::as_bibentry(x = "CITATION.cff"))
83+
```
84+
85+
## Contact
86+
Please contact [Andree Valle-Campos](mailto:[email protected]) with any questions about this tutorial.

README.md

+84-24
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,106 @@
11

22
<!-- README.md is generated from README.Rmd. Please edit that file -->
33

4-
# tutorials
4+
# Epiverse-TRACE Tutorials Middle
55

66
<!-- badges: start -->
77

8-
[![](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
9-
[![Project Status: WIP - Initial development is in progress, but there
10-
has not yet been a stable, usable release suitable for the
11-
public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
8+
[![](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
9+
[![Project Status: Active - The project has reached a stable, usable
10+
state and is being actively
11+
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
1212
<!-- badges: end -->
1313

14-
The goal of `tutorials` is to host tutorials for Outbreak analytics with
15-
R.
14+
Tutorials on real-time analysis and forecasting for outbreak analytics
15+
with R developed by the Epiverse-TRACE initiative. These tutorials are
16+
visible at: <https://epiverse-trace.github.io/tutorials-middle/>.
1617

17-
## Usage
18-
19-
> NOTE: The expected date for the deployment of the first set of
20-
> tutorials is mid-November 2023.
21-
22-
Visualize this content as a webpage at
23-
<https://epiverse-trace.github.io/tutorials/>
24-
25-
To build the website locally, please refer to [the contributing
26-
guidelines](CONTRIBUTING.md).
18+
More information about Epiverse-TRACE learning material is available at:
19+
<https://epiverse-trace.github.io/learn.html>
2720

2821
## Contributing
2922

30-
Contributions are always welcome!
23+
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for contributing
24+
guidelines and details on how to get involved with this project. Please
25+
adhere to this project’s [Code of Conduct](CODE_OF_CONDUCT.md).
3126

32-
See our [Contributing guide](CONTRIBUTING.md) for ways to get started.
27+
Also see the current list of
28+
[issues](https://github.com/epiverse-trace/tutorials-middle/issues) for
29+
ideas on how to contribute to this training curriculum.
3330

34-
Please adhere to this project’s [Code of Conduct](CODE_OF_CONDUCT.md).
31+
To learn more about how this lesson site is built and how you can edit
32+
the pages, see the [Introduction to The Carpentries
33+
Workbench](https://carpentries.github.io/sandpaper-docs/).
3534

3635
<!-- ## Support -->
3736
<!-- Please see our [Getting help guide](/.github/SUPPORT.md) for support. -->
3837

3938
## License
4039

41-
Read the [License](LICENSE.md) of this tutorial.
40+
Lesson content is published with a [CC-BY license](LICENSE.md).
41+
42+
## Maintainer(s)
43+
44+
Current maintainers of these tutorials are:
45+
46+
- [Andree Valle-Campos](https://github.com/avallecam/) (Content)
47+
- [Hugo Gruson](https://github.com/Bisaloo/) (Infrastructure)
48+
49+
<!--
50+
Former maintainers:
51+
&#10;- [Andree Valle-Campos](https://github.com/avallecam/)
52+
&#10;-->
53+
<!--## Acknowledgements-->
54+
55+
## Related
56+
57+
Epiverse-TRACE documentation:
58+
59+
- [How-to guides](https://epiverse-trace.github.io/howto/): Reproducible
60+
recipes with concrete steps to solve specific Outbreak Analysis
61+
questions using multiple packages.
62+
- [Reference manuals and
63+
vignettes](https://epiverse-trace.github.io/getting-started.html#epiverse-trace-packages):
64+
Package-specific usage guides and function examples, along with
65+
explanatory articles.
66+
67+
Preliminary learning materials:
68+
69+
- [Introductory R
70+
tutorials](https://appliedepi.org/resources/tutorials.html): Refresh
71+
your R knowledge with interactive online self-paced tutorials from the
72+
Applied Epi organization.
73+
- [The Epidemiologist R
74+
Handbook](https://www.epirhandbook.com/en/index.html): Online book on
75+
basics, data management, epidemiological analysis, visualization, and
76+
reporting from the Applied Epi organization.
77+
78+
## Citation
79+
80+
See [CITATION.cff](CITATION.cff) for citation information, including a
81+
list of authors. ([Read more about the Citation File Format and how to
82+
use it](https://citation-file-format.github.io/).)
83+
84+
To cite these tutorials in publications use:
85+
86+
Valle-Campos A, Minter A (2025). "Epiverse-TRACE Tutorials Middle:
87+
Real-time analysis and forecasting for outbreak analytics with R."
88+
<https://epiverse-trace.github.io/tutorials-middle/>.
89+
90+
A BibTeX entry for LaTeX users is:
91+
92+
@Misc{vallecampos_etall:2025,
93+
title = {Epiverse-TRACE Tutorials Middle: Real-time analysis and forecasting for outbreak analytics with R},
94+
author = {Andree Valle-Campos and Amanda Minter},
95+
year = {2025},
96+
url = {https://epiverse-trace.github.io/tutorials-middle/},
97+
abstract = {The Epiverse-TRACE initiative aims to provide a software ecosystem for outbreak analytics with integrated, generalisable and scalable community-driven software. We support the development of R packages, make the existing ones interoperable for the user experience, and stimulate a community of practice. In the outbreak analytics curriculum, we built three tutorials around an outbreak analysis pipeline split into three stages: Early, Middle, and Late tasks. Early tasks include reading, cleaning and validating case data, and converting line list data to incidence for visualizing epidemic curves. Middle tasks host real-time analysis that includes accessing epidemiological delays, estimating transmission metrics, forecasting, and severity from incidence data, superspreading from line list and contact data, and simulating transmission chains. Late tasks include accessing and analyzing social contact matrices, scenario modelling to simulate disease spread and investigate interventions, and modelling disease burden.},
98+
keywords = {outbreak-analytics,epidemiological-parameters,reproduction-number,forecasting,outbreak-severity,superspreading events,transmission chains,carpentries-workbench,rstats,english-language},
99+
version = {v2025-03-11},
100+
}
42101

43-
## Authors
102+
## Contact
44103

45-
- [@amanda-minter](https://github.com/amanda-minter/)
46-
- [@avallecam](https://github.com/avallecam/)
104+
Please contact [Andree
105+
Valle-Campos](mailto:[email protected]) with any questions
106+
about this tutorial.

0 commit comments

Comments
 (0)