vimc.rpkg.template/README.Rmd at main · vimc/vimc.rpkg.template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
---
output: github_document
# NOTE: place references if any as a JSON in `vignettes/resources`
# NOTE: references file can have any name, and there can be separate references per vignette
bibliography: vignettes/resources/references.json
link-citations: true
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# 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/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 -->

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

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, including authors;

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

3. Remove these instructions from `README.Rmd`. Then, either let the automated GitHub Actions workflow update `README.md` once the change is pushed to GitHub, or disable the workflow by removing the file `.github/workflows/render-readme.yaml`, and manually re-render the `.md` file using `devtools::render_readme()`.

## Installation

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

**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(
  "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("vimc/vimc.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.

## Related projects

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

An example citation would be @echeverria-londono2021.

## References

**Space for references: REMOVE this sub-section if there are no references. References, if any, should appear below this text. Remove this text in packages.**