Skip to contents

ji.rpkg.template: TAGLINE

ji.rpkg.template is a template package and repository on which future Jameel Institute 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:

  1. Edit the DESCRIPTION as appropriate with the correct package information;

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

  3. 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:

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

or from GitHub GitHub with:

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

Quick start

Add a simple example of using the package’s main feature(s) here, with a minimum amount of code. If preparatory or plotting steps are needed, prefer to hide them to keep focus on the package functionality.

Add information and links to related projects, such as research papers or packages, here.

References

Space for references: REMOVE this text.