Skip to content

Commit 893a64a

Browse files
Update pkg infra for init rename
1 parent 491d6f3 commit 893a64a

File tree

9 files changed

+51
-48
lines changed

9 files changed

+51
-48
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@
1313
^docs$
1414
^pkgdown$
1515
^tools$
16+
^scratch\.R$

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,4 @@ po/*~
4949
rsconnect/
5050
inst/doc
5151
docs
52+
scratch.R

.lintr

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
linters: all_linters(
22
indentation_linter = NULL, # unstable as of lintr 3.1.0
3-
extraction_operator_linter = NULL, # lints auto-generated vignette setup chunks
43
implicit_integer_linter = NULL, # turn off due to multiple integerish values used
54
duplicate_argument_linter = NULL, # due to cli_bullets
65
object_name_linter = NULL, # due to S3 methods
@@ -20,8 +19,5 @@ exclusions: list(
2019
),
2120
"vignettes" = list(
2221
undesirable_function_linter = Inf
23-
),
24-
# do no attempt to lint auto-generated files
25-
"R/RcppExports.R",
26-
"R/cpp11.R"
22+
)
2723
)

DESCRIPTION

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
1-
Package: vimc.rpkg.template
2-
Title: Your Package Title in Title Case
1+
Package: vimcheck
2+
Title: Diagnostics for Vaccination Modelling Burden and Impact Estimates
33
Version: 0.0.0.9000
44
Authors@R: c(
55
person("Pratik", "Gupte", , "p.gupte24@imperial.ac.uk", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0001-5294-7819")),
7+
person("Katy", "Gaythorpe", role = "aut",
8+
comment = c(ORCID = "0000-0003-3734-9081")),
9+
person("Xiang", "Li", role = "aut",
10+
comment = c(ORCID = "0000-0002-5945-159X")),
11+
person("Zoe", "Gibney", role = "aut"),
712
person("Imperial College of Science, Technology and Medicine", role = c("cph", "fnd"))
813
)
9-
Description: Your package description. It must end with a period (".") and
10-
include relevant bibliographical references if applicable, using the
11-
following format: Author et al. (2023) <doi:10.5281/zenodo.6619350>.
14+
Description: Run diagnostics on burden estimates submitted to the Vaccine
15+
Impact Modelling Consortium (VIMC), and impacts estimated by VIMC, as
16+
described in Echeverria-Londono et al. (2021)
17+
<doi:10.1186/s12889-021-12040-9>.
1218
License: MIT + file LICENSE
19+
URL: https://github.com/vimc/vimcheck, https://vimc.github.io/vimcheck/
20+
BugReports: https://github.com/vimc/vimcheck/issues
1321
Suggests:
1422
knitr,
1523
rmarkdown,

NAMESPACE

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
# Generated by roxygen2: do not edit by hand
22

3-
export(get_manual_mean)

NEWS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# vimc.rpkg.template 0.0.1
1+
# vimcheck 0.0.1
22

3-
* This project now includes a
4-
[`NEWS.md`](https://r-pkgs.org/other-markdown.html#sec-news) file to inform
5-
users about changes and new features.
3+
- Added GHA workflows to notify of changed dependencies, auto-render `README.md` from `README.Rmd`, and update the copyright year annually.
4+
5+
- Added reference to VIMC paper (Echeverria-Londono et al. 2021).

README.Rmd

Lines changed: 11 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
output: github_document
3-
# add bibliography here
3+
bibliography: vignettes/resources/references.json
44
link-citations: true
55
---
66

@@ -15,40 +15,25 @@ knitr::opts_chunk$set(
1515
)
1616
```
1717

18-
# vimc.rpkg.template: TAGLINE
18+
# vimcheck: Diagnostics for vaccination modelling burden and impact estimates
1919

2020
<!-- badges: start -->
2121
[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
22-
[![R build status](https://github.com/vimc/vimc.rpkg.template/workflows/R-CMD-check/badge.svg)](https://github.com/vimc/vimc.rpkg.template/actions/workflows/R-CMD-check.yaml)
23-
[![Codecov test coverage](https://codecov.io/gh/vimc/vimc.rpkg.template/branch/main/graph/badge.svg)](https://app.codecov.io/gh/vimc/vimc.rpkg.template?branch=main)
24-
[![CRAN status](https://www.r-pkg.org/badges/version/vimc.rpkg.template)](https://CRAN.R-project.org/package=vimc.rpkg.template)
22+
[![R build status](https://github.com/vimc/vimcheck/workflows/R-CMD-check/badge.svg)](https://github.com/vimc/vimcheck/actions/workflows/R-CMD-check.yaml)
23+
[![Codecov test coverage](https://codecov.io/gh/vimc/vimcheck/branch/main/graph/badge.svg)](https://app.codecov.io/gh/vimc/vimcheck?branch=main)
24+
[![CRAN status](https://www.r-pkg.org/badges/version/vimcheck)](https://CRAN.R-project.org/package=vimcheck)
2525
<!-- badges: end -->
2626

27-
_vimc.rpkg.template_ is a template package and repository on which future VIMC R packages are based.
28-
29-
To use this template, select _vimc.rpkg.template_ from the drop-down menu under **Repository template** when creating a new repository in the VIMC GitHub organisation.
30-
Replace all instances of `"vimc.rpkg.template"` with your package name. Make sure to also:
31-
32-
1. Edit the `DESCRIPTION` as appropriate with the correct package information, including authors;
33-
34-
2. Edit the files in `R/`, `tests/`, and `vignettes/` to suit your package;
35-
36-
3. Add spell check by running `usethis::use_spell_check(lang = "en-GB")`;
37-
38-
4. Remove these instructions from `README.Rmd`, and re-render the `.md` file using `devtools::render_readme()`.
27+
_vimcheck_ is an R package for running diagnostic checks on burden estimates submitted to the Vaccine Impact Modelling Consortium (VIMC), and on impact estimates calculated by VIMC.
3928

4029
## Installation
4130

42-
**NOTE:** Remove or comment out installation sources as appropriate.
43-
44-
**Remember** to add the package to the [VIMC R-universe](https://github.com/vimc/vimc.r-universe.dev).
45-
46-
You can install the development version of _vimc.rpkg.template_ from the VIMC R-universe with:
31+
You can install the development version of _vimcheck_ from the VIMC R-universe with:
4732

4833
```r
4934
installation from R-universe
5035
install.packages(
51-
"vimc.rpkg.template",
36+
"vimcheck",
5237
repos = c(
5338
"https://vimc.r-universe.dev", "https://cloud.r-project.org"
5439
)
@@ -59,18 +44,15 @@ or from GitHub [GitHub](https://github.com/) with:
5944

6045
``` r
6146
install.packages("pak")
62-
pak::pak("vimc/vimc.rpkg.template")
47+
pak::pak("vimc/vimcheck")
6348
```
6449

6550
## Quick start
6651

67-
Add a simple example of using the package's main feature(s) here, with a minimum amount of code.
68-
If preparatory or plotting steps are needed, prefer to hide them to keep focus on the package functionality.
52+
WIP.
6953

7054
## Related projects
7155

72-
Add information and links to related projects, such as research papers or packages, here.
56+
VIMC impact assessment workflows are described in @echeverria-londono2021.
7357

7458
## References
75-
76-
Space for references: REMOVE this text.

inst/WORDLIST

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
1+
BMC
12
Codecov
3+
De
4+
Echeverria
5+
GHA
6+
Hallett
7+
Jaspreet
8+
Kaja
9+
Londono
10+
Modelling
11+
Nayagam
212
ORCID
3-
TAGLINE
13+
Shevanthi
14+
Susy
15+
Toor
416
VIMC
17+
Villiers
18+
WIP
19+
al
520
doi
21+
et
22+
explainers
23+
funder
24+
modelling
625
pkgdown
7-
rpkg
8-
vimc
9-
zenodo
File renamed without changes.

0 commit comments

Comments
 (0)