Skip to content

Commit 038f0c1

Browse files
committed
New site build
1 parent aaaf914 commit 038f0c1

File tree

9 files changed

+881
-1
lines changed

9 files changed

+881
-1
lines changed

.github/workflows/pkgdown.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
needs: website
3838

3939
- name: Build site
40-
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
40+
run: usethis::use_pkgdown_github_pages()
4141
shell: Rscript {0}
4242

4343
- name: Deploy to GitHub pages 🚀

_pkgdown.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
destination: docs
2+
authors:
3+
Rafael Lopes:
4+
href: https://github.com/rafalopespx
5+
Leonardo Bastos:
6+
href: https://github.com/lsbastos/
7+
footer:
8+
text: Casted by
9+
url: https://covid19br.github.io/nowcaster/
10+
template:
11+
bootstrap: 5
12+
bootswatch: cerulean
13+
navbar:
14+
structure:
15+
left:
16+
- intro
17+
- reference
18+
- articles
19+
- tutorials
20+
- news
21+
right:
22+
- search
23+
- github
24+
footer:
25+
structure:
26+
left: developed_by
27+
right: built_with
28+
home:
29+
sidebar:
30+
structure:
31+
- links
32+
- license
33+
- community
34+
- citation
35+
- authors
36+
- dev
37+

index.Rmd

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: "Nowcaster"
3+
output: github_document
4+
---
5+
6+
```{r setup, include=FALSE}
7+
knitr::opts_chunk$set(
8+
echo = TRUE,
9+
message = FALSE,
10+
warning = FALSE
11+
)
12+
library(badger)
13+
```
14+
15+
16+
<a href='https://github.com/covid19br/nowcaster'><img src='man/figures/nowcaster.png' align="right" width="140" /></a> <a href='https://github.com/covid19br/nowcaster'><img src='man/figures/nowcaster_rev.png' align="right" width="140" /></a>
17+
18+
<!-- badges: start -->
19+
<!-- `r badger::badge_cran_checks(pkg = NULL)` -->
20+
<!-- `r badger::badge_dependencies(pkg = NULL)` -->
21+
`r badger::badge_devel(pkg = "nowcaster", color = "blue")`
22+
`r badger::badge_license(url = "https://github.com/covid19br/nowcaster/blob/main/LICENSE.md")`
23+
`r badger::badge_lifecycle(stage = "experimental")`
24+
<!-- badges: end -->
25+
26+
`nowcaster` is an R package for “nowcasting” epidemiological time-series on individual level data.
27+
28+
Every single system of notification has an intrinsic delay between the `date of onset` of the event and the `date of report`.
29+
`nowcaster` can estimate how many counts of any epidemiological data of interest
30+
(*i.e.*, daily cases and deaths counts) by fitting a negative binomial
31+
model to the time steps of delay between onset date of the event,
32+
(*i.e.*, date of first symptoms for cases or date of occurrence of
33+
death) and the date of report (*i.e.*, date of notification of the case
34+
or death).
35+
36+
## Installing
37+
38+
After have a proper `INLA` installation to install `nowcaster` package simply run the code below in R:
39+
40+
```{r Installing, eval=FALSE, message=FALSE, warning=FALSE, include=TRUE}
41+
devtools::install_github("https://github.com/covid19br/nowcaster")
42+
```
43+
If you have any problem installing, please refer to next section on the dependencies of the package.
44+
45+
## Dependencies
46+
47+
`nowcaster` is based on the
48+
[`R-INLA`](https://www.r-inla.org/download-install)
49+
and
50+
[`INLA`](https://inla.r-inla-download.org/r-inla.org/doc/inla-manual/inla-manual.pdf)
51+
packages for “**I**ntegrated **N**ested **L**aplace **A**pproximation”
52+
algorithm to Bayesian inference. `INLA` is a fast alternative to others
53+
methods for Bayesian inference like **MCMC**. An introduction to `INLA`
54+
can be found
55+
[here](https://becarioprecario.bitbucket.io/inla-gitbook/index.html).
56+
57+
`nowcaster` it was built for epidemiological emergency use, it was
58+
constructed for the Brazilian Severe Acute Respiratory Illness (SARI)
59+
surveillance system (SIVEP-Gripe), at the time of Covid-19 pandemic.
60+
61+
Before installing the package certify you have an active installation of `INLA`,
62+
to do so you can run the following code:
63+
64+
```{r Installing INLA, eval=FALSE, message=FALSE, warning=FALSE, include=TRUE}
65+
install.packages("INLA",
66+
repos=c(getOption("repos"),
67+
INLA="https://inla.r-inla-download.org/R/stable"),
68+
dep=TRUE)
69+
```
70+
71+
If you want more detail on other possible installations of `INLA`, please refer to the official [page](https://www.r-inla.org/download-install) of the package.
72+
73+
## Similar Initiatives
74+
75+
There are other alternative packages, that can produce nowcasting estimation, here it is some options:
76+
77+
* [Epinowcast](https://package.epinowcast.org/)
78+
* [Surveillance](https://surveillance.r-forge.r-project.org/pkgdown/index.html)

index.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
Nowcaster
2+
================
3+
4+
<a href='https://github.com/covid19br/nowcaster'><img src='man/figures/nowcaster.png' align="right" width="140" /></a>
5+
<a href='https://github.com/covid19br/nowcaster'><img src='man/figures/nowcaster_rev.png' align="right" width="140" /></a>
6+
7+
<!-- badges: start -->
8+
9+
<!-- [![CRAN checks](https://badges.cranchecks.info/summary/nowcaster.svg)](https://cran.r-project.org/web/checks/check_results_nowcaster.html) -->
10+
11+
<!-- [![Dependencies](https://tinyverse.netlify.com/badge/nowcaster)](https://cran.r-project.org/package=nowcaster) -->
12+
13+
[![](https://img.shields.io/badge/devel%20version-0.2.3-blue.svg)](https://github.com/nowcaster)
14+
[![License: GPL (\>=
15+
3)](https://img.shields.io/badge/license-GPL%20(%3E=%203)-blue.svg)](https://github.com/covid19br/nowcaster/blob/main/LICENSE.md)
16+
[![](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
17+
<!-- badges: end -->
18+
19+
`nowcaster` is an R package for “nowcasting” epidemiological time-series
20+
on individual level data.
21+
22+
Every single system of notification has an intrinsic delay between the
23+
`date of onset` of the event and the `date of report`. `nowcaster` can
24+
estimate how many counts of any epidemiological data of interest
25+
(*i.e.*, daily cases and deaths counts) by fitting a negative binomial
26+
model to the time steps of delay between onset date of the event,
27+
(*i.e.*, date of first symptoms for cases or date of occurrence of
28+
death) and the date of report (*i.e.*, date of notification of the case
29+
or death).
30+
31+
## Installing
32+
33+
After have a proper `INLA` installation to install `nowcaster` package
34+
simply run the code below in R:
35+
36+
``` r
37+
devtools::install_github("https://github.com/covid19br/nowcaster")
38+
```
39+
40+
If you have any problem installing, please refer to next section on the
41+
dependencies of the package.
42+
43+
## Dependencies
44+
45+
`nowcaster` is based on the
46+
[`R-INLA`](https://www.r-inla.org/download-install) and
47+
[`INLA`](https://inla.r-inla-download.org/r-inla.org/doc/inla-manual/inla-manual.pdf)
48+
packages for “**I**ntegrated **N**ested **L**aplace **A**pproximation”
49+
algorithm to Bayesian inference. `INLA` is a fast alternative to others
50+
methods for Bayesian inference like **MCMC**. An introduction to `INLA`
51+
can be found
52+
[here](https://becarioprecario.bitbucket.io/inla-gitbook/index.html).
53+
54+
`nowcaster` it was built for epidemiological emergency use, it was
55+
constructed for the Brazilian Severe Acute Respiratory Illness (SARI)
56+
surveillance system (SIVEP-Gripe), at the time of Covid-19 pandemic.
57+
58+
Before installing the package certify you have an active installation of
59+
`INLA`, to do so you can run the following code:
60+
61+
``` r
62+
install.packages("INLA",
63+
repos=c(getOption("repos"),
64+
INLA="https://inla.r-inla-download.org/R/stable"),
65+
dep=TRUE)
66+
```
67+
68+
If you want more detail on other possible installations of `INLA`,
69+
please refer to the official
70+
[page](https://www.r-inla.org/download-install) of the package.
71+
72+
## Similar Initiatives
73+
74+
There are other alternative packages, that can produce nowcasting
75+
estimation, here it is some options:
76+
77+
- [Epinowcast](https://package.epinowcast.org/)
78+
- [Surveillance](https://surveillance.r-forge.r-project.org/pkgdown/index.html)

vignettes/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.html
2+
*.R

0 commit comments

Comments
 (0)