Skip to content
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
6 changes: 2 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Package: ji.rpkg.template
Package: vimc.rpkg.template
Title: Your Package Title in Title Case
Version: 0.0.0.9000
Authors@R: c(
person("Pratik", "Gupte", , "pratik.gupte@lshtm.ac.uk", role = c("aut", "cre"),
person("Pratik", "Gupte", , "p.gupte24@imperial.ac.uk", role = c("aut", "cre"),
comment = c(ORCID = "0000-0001-5294-7819")),
person("Abdul Latif Jameel Institute for Disease and Emergency Analytics", role = "fnd"),
person("Imperial College of Science, Technology and Medicine", role = c("cph", "fnd"))
)
Description: Your package description. It must end with a period (".") and
Expand All @@ -18,7 +17,6 @@ Suggests:
testthat (>= 3.0.0)
VignetteBuilder:
knitr
Config/Needs/website: jameel-institute/jameelinst.rpkg.theme
Config/testthat/edition: 3
Encoding: UTF-8
Language: en-GB
Expand Down
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2024
COPYRIGHT HOLDER: ji.rpkg.template authors
YEAR: 2025
COPYRIGHT HOLDER: Imperial College of Science, Technology and Medicine
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIT License

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

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ji.rpkg.template 0.0.1
# vimc.rpkg.template 0.0.1

* This project now includes a
[`NEWS.md`](https://r-pkgs.org/other-markdown.html#sec-news) file to inform
Expand Down
File renamed without changes.
40 changes: 21 additions & 19 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,49 +15,51 @@ knitr::opts_chunk$set(
)
```

# ji.rpkg.template: TAGLINE
# vimc.rpkg.template: TAGLINE

<!-- badges: start -->
[![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)
[![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)
[![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)
[![CRAN status](https://www.r-pkg.org/badges/version/ji.rpkg.template)](https://CRAN.R-project.org/package=ji.rpkg.template)
[![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)
[![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)
[![CRAN status](https://www.r-pkg.org/badges/version/vimc.rpkg.template)](https://CRAN.R-project.org/package=vimc.rpkg.template)
<!-- badges: end -->

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

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.
Replace all instances of "ji.rpkg.template" with your package name. Make sure to also:
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.
Replace all instances of `"vimc.rpkg.template"` with your package name. Make sure to also:

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

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

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

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

## Installation

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

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

You can install the development version of _vimc.rpkg.template_ from the VIMC R-universe with:

```r
# installation from R-universe
# install.packages(
# "ji.rpkg.template",
# repos = c(
# "https://jameel-institute.r-universe.dev", "https://cloud.r-project.org"
# )
# )
installation from R-universe
install.packages(
"vimc.rpkg.template",
repos = c(
"https://vimc.r-universe.dev", "https://cloud.r-project.org"
)
)
```

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

``` r
# install.packages("pak")
# pak::pak("jameel-institute/ji.rpkg.template")
install.packages("pak")
pak::pak("vimc/vimc.rpkg.template")
```

## Quick start
Expand Down
50 changes: 27 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

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

# ji.rpkg.template: TAGLINE
# vimc.rpkg.template: TAGLINE

<!-- badges: start -->

Expand All @@ -10,28 +10,29 @@ 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)
[![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)
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)
[![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)
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)
[![CRAN
status](https://www.r-pkg.org/badges/version/ji.rpkg.template)](https://CRAN.R-project.org/package=ji.rpkg.template)
status](https://www.r-pkg.org/badges/version/vimc.rpkg.template)](https://CRAN.R-project.org/package=vimc.rpkg.template)
<!-- badges: end -->

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

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. Replace all instances of
“ji.rpkg.template with your package name. Make sure to also:
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. Replace all instances of
`"vimc.rpkg.template"` with your package name. Make sure to also:

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

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

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

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

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

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

You can install the development version of *vimc.rpkg.template* from the
VIMC R-universe with:

``` r
# installation from R-universe
# install.packages(
# "ji.rpkg.template",
# repos = c(
# "https://jameel-institute.r-universe.dev", "https://cloud.r-project.org"
# )
# )
installation from R-universe
install.packages(
"vimc.rpkg.template",
repos = c(
"https://vimc.r-universe.dev", "https://cloud.r-project.org"
)
)
```

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

``` r
# install.packages("pak")
# pak::pak("jameel-institute/ji.rpkg.template")
install.packages("pak")
pak::pak("vimc/vimc.rpkg.template")
```

## Quick start
Expand Down
3 changes: 1 addition & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# NOTE: Update the `url` field as needed
# e.g. "https://jameel-institute.github.io/daedalus/"
# e.g. "https://vimc.github.io/vimpact/"
url: ~
template:
bootstrap: 5
package: jameelinst.rpkg.theme
5 changes: 2 additions & 3 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Codecov
Jameel
ORCID
TAGLINE
Un
VIMC
doi
ji
pkgdown
rpkg
vimc
zenodo

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion tests/spelling.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
if (requireNamespace("spelling", quietly = TRUE)) {
spelling::spell_check_test(
vignettes = TRUE, error = FALSE,
vignettes = TRUE,
error = FALSE,
skip_on_cran = TRUE
)
}
4 changes: 2 additions & 2 deletions tests/testthat.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
# * https://testthat.r-lib.org/articles/special-files.html

library(testthat)
library(ji.rpkg.template)
library(vimc.rpkg.template)

test_check("ji.rpkg.template")
test_check("vimc.rpkg.template")
21 changes: 10 additions & 11 deletions tests/testthat/helper-state.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,17 @@ get_pars_toreset <- function() {
if (getRversion() >= "4.0.0") {
testthat::set_state_inspector(function() {
list(
attached = search(),
attached = search(),
connections = getAllConnections(),
cwd = getwd(),
envvars = Sys.getenv(),
handlers = globalCallingHandlers(),
libpaths = .libPaths(),
locale = Sys.getlocale(),
options = options(),
par = get_pars_toreset(),
packages = .packages(all.available = TRUE),
sink = sink.number(),
timezone = Sys.timezone(),
cwd = getwd(),
envvars = Sys.getenv(),
handlers = globalCallingHandlers(),
libpaths = .libPaths(),
locale = Sys.getlocale(),
options = options(),
packages = .packages(all.available = TRUE),
sink = sink.number(),
timezone = Sys.timezone(),
NULL
)
})
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "ji-rpkg-template"
title: "vimc-rpkg-template"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{ji-rpkg-template}
%\VignetteIndexEntry{vimc-rpkg-template}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
Expand All @@ -15,7 +15,7 @@ knitr::opts_chunk$set(
```

```{r setup}
library(ji.rpkg.template)
library(vimc.rpkg.template)
```

This is a special vignette, which shares the same name as the package.
Expand Down
File renamed without changes.