Skip to content

Commit b44acbe

Browse files
pratikunterwegspratikunterwegs
committed
Update JI template for VIMC
1 parent e268897 commit b44acbe

15 files changed

Lines changed: 80 additions & 79 deletions

‎DESCRIPTION‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
Package: ji.rpkg.template
1+
Package: vimc.rpkg.template
22
Title: Your Package Title in Title Case
33
Version: 0.0.0.9000
44
Authors@R: c(
5-
person("Pratik", "Gupte", , "pratik.gupte@lshtm.ac.uk", role = c("aut", "cre"),
5+
person("Pratik", "Gupte", , "p.gupte24@imperial.ac.uk", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0001-5294-7819")),
7-
person("Abdul Latif Jameel Institute for Disease and Emergency Analytics", role = "fnd"),
87
person("Imperial College of Science, Technology and Medicine", role = c("cph", "fnd"))
98
)
109
Description: Your package description. It must end with a period (".") and
@@ -18,7 +17,6 @@ Suggests:
1817
testthat (>= 3.0.0)
1918
VignetteBuilder:
2019
knitr
21-
Config/Needs/website: jameel-institute/jameelinst.rpkg.theme
2220
Config/testthat/edition: 3
2321
Encoding: UTF-8
2422
Language: en-GB

‎LICENSE‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
YEAR: 2024
2-
COPYRIGHT HOLDER: ji.rpkg.template authors
1+
YEAR: 2025
2+
COPYRIGHT HOLDER: Imperial College of Science, Technology and Medicine

‎LICENSE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MIT License
22

3-
Copyright (c) 2024 ji.rpkg.template authors
3+
Copyright (c) 2025 Imperial College of Science, Technology and Medicine
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎NEWS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ji.rpkg.template 0.0.1
1+
# vimc.rpkg.template 0.0.1
22

33
* This project now includes a
44
[`NEWS.md`](https://r-pkgs.org/other-markdown.html#sec-news) file to inform

R/ji.rpkg.template-package.R renamed to R/vimc.rpkg.template-package.R

File renamed without changes.

‎README.Rmd‎

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,49 +15,51 @@ knitr::opts_chunk$set(
1515
)
1616
```
1717

18-
# ji.rpkg.template: TAGLINE
18+
# vimc.rpkg.template: TAGLINE
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/jameel-institute/ji.rpkg.template/workflows/R-CMD-check/badge.svg)](https://github.com/jameel-institute/ji.rpkg.template/actions/workflows/R-CMD-check.yaml)
23-
[![Codecov test coverage](https://codecov.io/gh/jameel-institute/ji.rpkg.template/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jameel-institute/ji.rpkg.template?branch=main)
24-
[![CRAN status](https://www.r-pkg.org/badges/version/ji.rpkg.template)](https://CRAN.R-project.org/package=ji.rpkg.template)
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)
2525
<!-- badges: end -->
2626

27-
_ji.rpkg.template_ is a template package and repository on which future Jameel Institute packages are based.
27+
_vimc.rpkg.template_ is a template package and repository on which future VIMC R packages are based.
2828

29-
To use this template, select _ji.rpkg.template_ from the drop-down menu under **Repository template** when creating a new repository in the Jameel Institute organisation.
30-
Replace all instances of "ji.rpkg.template" with your package name. Make sure to also:
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:
3131

32-
1. Edit the `DESCRIPTION` as appropriate with the correct package information;
32+
1. Edit the `DESCRIPTION` as appropriate with the correct package information, including authors;
3333

3434
2. Edit the files in `R/`, `tests/`, and `vignettes/` to suit your package;
3535

36-
3. Add spell check by running usethis::use_spell_check(lang = "en-GB")
36+
3. Add spell check by running `usethis::use_spell_check(lang = "en-GB")`;
3737

3838
4. Remove these instructions from `README.Rmd`, and re-render the `.md` file using `devtools::render_readme()`.
3939

4040
## Installation
4141

4242
**NOTE:** Remove or comment out installation sources as appropriate.
4343

44-
You can install the development version of ji.rpkg.template from the Jameel Institute R-universe with:
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:
4547

4648
```r
47-
# installation from R-universe
48-
# install.packages(
49-
# "ji.rpkg.template",
50-
# repos = c(
51-
# "https://jameel-institute.r-universe.dev", "https://cloud.r-project.org"
52-
# )
53-
# )
49+
installation from R-universe
50+
install.packages(
51+
"vimc.rpkg.template",
52+
repos = c(
53+
"https://vimc.r-universe.dev", "https://cloud.r-project.org"
54+
)
55+
)
5456
```
5557

5658
or from GitHub [GitHub](https://github.com/) with:
5759

5860
``` r
59-
# install.packages("pak")
60-
# pak::pak("jameel-institute/ji.rpkg.template")
61+
install.packages("pak")
62+
pak::pak("vimc/vimc.rpkg.template")
6163
```
6264

6365
## Quick start

‎README.md‎

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

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

4-
# ji.rpkg.template: TAGLINE
4+
# vimc.rpkg.template: TAGLINE
55

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

@@ -10,28 +10,29 @@ yet, or the repository is only intended to be a limited example, demo,
1010
or
1111
proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
1212
[![R build
13-
status](https://github.com/jameel-institute/ji.rpkg.template/workflows/R-CMD-check/badge.svg)](https://github.com/jameel-institute/ji.rpkg.template/actions/workflows/R-CMD-check.yaml)
13+
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)
1414
[![Codecov test
15-
coverage](https://codecov.io/gh/jameel-institute/ji.rpkg.template/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jameel-institute/ji.rpkg.template?branch=main)
15+
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)
1616
[![CRAN
17-
status](https://www.r-pkg.org/badges/version/ji.rpkg.template)](https://CRAN.R-project.org/package=ji.rpkg.template)
17+
status](https://www.r-pkg.org/badges/version/vimc.rpkg.template)](https://CRAN.R-project.org/package=vimc.rpkg.template)
1818
<!-- badges: end -->
1919

20-
*ji.rpkg.template* is a template package and repository on which future
21-
Jameel Institute packages are based.
20+
*vimc.rpkg.template* is a template package and repository on which
21+
future VIMC R packages are based.
2222

23-
To use this template, select *ji.rpkg.template* from the drop-down menu
24-
under **Repository template** when creating a new repository in the
25-
Jameel Institute organisation. Replace all instances of
26-
“ji.rpkg.template” with your package name. Make sure to also:
23+
To use this template, select *vimc.rpkg.template* from the drop-down
24+
menu under **Repository template** when creating a new repository in the
25+
VIMC GitHub organisation. Replace all instances of
26+
`"vimc.rpkg.template"` with your package name. Make sure to also:
2727

2828
1. Edit the `DESCRIPTION` as appropriate with the correct package
29-
information;
29+
information, including authors;
3030

3131
2. Edit the files in `R/`, `tests/`, and `vignettes/` to suit your
3232
package;
3333

34-
3. Add spell check by running usethis::use_spell_check(lang = “en-GB”)
34+
3. Add spell check by running
35+
`usethis::use_spell_check(lang = "en-GB")`;
3536

3637
4. Remove these instructions from `README.Rmd`, and re-render the `.md`
3738
file using `devtools::render_readme()`.
@@ -40,24 +41,27 @@ Jameel Institute organisation. Replace all instances of
4041

4142
**NOTE:** Remove or comment out installation sources as appropriate.
4243

43-
You can install the development version of ji.rpkg.template from the
44-
Jameel Institute R-universe with:
44+
**Remember** to add the package to the [VIMC
45+
R-universe](https://github.com/vimc/vimc.r-universe.dev).
46+
47+
You can install the development version of *vimc.rpkg.template* from the
48+
VIMC R-universe with:
4549

4650
``` r
47-
# installation from R-universe
48-
# install.packages(
49-
# "ji.rpkg.template",
50-
# repos = c(
51-
# "https://jameel-institute.r-universe.dev", "https://cloud.r-project.org"
52-
# )
53-
# )
51+
installation from R-universe
52+
install.packages(
53+
"vimc.rpkg.template",
54+
repos = c(
55+
"https://vimc.r-universe.dev", "https://cloud.r-project.org"
56+
)
57+
)
5458
```
5559

5660
or from GitHub [GitHub](https://github.com/) with:
5761

5862
``` r
59-
# install.packages("pak")
60-
# pak::pak("jameel-institute/ji.rpkg.template")
63+
install.packages("pak")
64+
pak::pak("vimc/vimc.rpkg.template")
6165
```
6266

6367
## Quick start

‎_pkgdown.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# NOTE: Update the `url` field as needed
2-
# e.g. "https://jameel-institute.github.io/daedalus/"
2+
# e.g. "https://vimc.github.io/vimpact/"
33
url: ~
44
template:
55
bootstrap: 5
6-
package: jameelinst.rpkg.theme

‎inst/WORDLIST‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
Codecov
2-
Jameel
32
ORCID
43
TAGLINE
5-
Un
4+
VIMC
65
doi
7-
ji
86
pkgdown
97
rpkg
8+
vimc
109
zenodo

man/ji.rpkg.template-package.Rd renamed to man/vimc.rpkg.template-package.Rd

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)