Skip to content

ci: document readme and add trigger buttons to all actions #256

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

Merged
merged 3 commits into from
Feb 27, 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
1 change: 1 addition & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
branches: [main, dev]
pull_request:
branches: [main, dev]
workflow_dispatch:

name: R-CMD-check

Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/document.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
paths: ["R/**"]
paths: ["R/**", "README.Rmd"]
workflow_dispatch:

name: Document

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
branches: [main, dev]
pull_request:
branches: [main, dev]
workflow_dispatch:

name: lint

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/style.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ on:
"**.[rR]nw",
"**.[rR]profile",
]
workflow_dispatch:

name: Style

Expand Down
6 changes: 6 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ forecasting models. We also provide packages for downstream data processing

## Usage

```{r, echo=FALSE}
# This is so that if you have USE_EPIDATR_CACHE=TRUE in your .Renviron, the
# startup message does not get included in the README.md when you build this.
suppressPackageStartupMessages(library(epidatr))
```

```{r}
library(epidatr)
# Obtain the smoothed covid-like illness (CLI) signal from Delphi's US COVID-19
Expand Down
7 changes: 0 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,6 @@ also provide packages for downstream data processing

``` r
library(epidatr)
#> ! epidatr cache is being used (set env var EPIDATR_USE_CACHE=FALSE if not
#> intended).
#> ℹ The cache directory is /fasterHome/workingDataDir/epidatr.
#> ℹ The cache will be cleared after 1 day and will be pruned if it exceeds 1024
#> MB.
#> ℹ The log of cache transactions is stored at
#> /fasterHome/workingDataDir/epidatr/logfile.txt.
# Obtain the smoothed covid-like illness (CLI) signal from Delphi's US COVID-19
# Trends and Impact Survey (CTIS), in partnership with Facebook, as it was on
# April 10, 2021 for the US at the national level
Expand Down