Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancements to README.Rmd #80

Closed
wants to merge 1 commit into from
Closed

Enhancements to README.Rmd #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .github/workflows/render_readme.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ jobs:
knitr::knit_expand(
"README.Rmd",
packagename = read.dcf("DESCRIPTION", "Package"),
institution = read.dcf("DESCRIPTION", "Config/Institution"),
department = read.dcf("DESCRIPTION", "Config/Department"),
department_url = read.dcf("DESCRIPTION", "Config/DepartmentURL"),
recon = read.dcf("DESCRIPTION", "Config/Recon"),
recon_description = read.dcf("DESCRIPTION", "Config/ReconDescription"),
gh_repo = Sys.getenv("GITHUB_REPOSITORY")
),
"README_expanded.Rmd"
Expand Down
5 changes: 5 additions & 0 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,9 @@ Suggests:
Config/testthat/edition: 3
Config/Needs/website:
epiverse-trace/epiversetheme
Config/Institution: London School of Hygiene and Tropical Medicine
Config/Needs/website: epiverse-trace/epiversetheme
Config/Department: Centre for the Mathematical Modelling of Infectious Diseases
Config/DepartmentURL: https://www.lshtm.ac.uk/research/centres/centre-mathematical-modelling-infectious-diseases
Config/Recon: experimental
Language: en-US
20 changes: 11 additions & 9 deletions README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ output: github_document
<!-- README.md is generated from README.Rmd. Please edit that file. -->
<!-- The code to render this README is stored in .github/workflows/render-readme.yaml -->
<!-- Variables marked with double curly braces will be transformed beforehand: -->
<!-- `packagename` is extracted from the DESCRIPTION file -->
<!-- `packagename`, `department`, `department_url`, `institution`, `recon`, `recon_description` is extracted from the DESCRIPTION file -->
<!-- `gh_repo` is extracted via a special environment variable in GitHub Actions -->


Expand All @@ -24,22 +24,23 @@ knitr::opts_chunk$set(
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/)
[![R-CMD-check](https://github.com/{{ gh_repo }}/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/{{ gh_repo }}/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/{{ gh_repo }}/branch/main/graph/badge.svg)](https://app.codecov.io/gh/{{ gh_repo }}?branch=main)
[![lifecycle-concept](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-concept.svg)](https://www.reconverse.org/lifecycle.html#concept)
[![lifecycle-{{ recon }}](https://www.reconverse.org/images/badge-{{ recon }}.svg)](https://www.reconverse.org/lifecycle.html#{{ recon }})
<!-- badges: end -->

{{ packagename }} provides functions to ....

<!-- This sentence is optional and can be removed -->
{{ packagename }} is developed at the [CENTER|similar](url) at the [UNIVERSITY|similar](url) as part of the [Epiverse-TRACE program](https://data.org/initiatives/epiverse/).
{{ packagename }} is developed at the [{{ department }}]({{ department_url }}) at the {{ institution }} as part of the [Epiverse-TRACE program](https://data.org/initiatives/epiverse/).

## Installation

You can install the development version of {{ packagename }} from
[GitHub](https://github.com/) with:

``` r
```{r eval=TRUE}
# install.packages("pak")
pak::pak("{{ gh_repo }}")
library("{{ packagename }}")
```

## Example
Expand All @@ -49,12 +50,13 @@ These examples illustrate some of the current functionalities

## Development

## Related packages and Limitations


### Lifecycle

This package is currently a *concept*, as defined by the [RECON software
lifecycle](https://www.reconverse.org/lifecycle.html). This means that essential
features and mechanisms are still being developed, and the package is not ready
for use outside of the development team.
This package is currently *{{ recon }}*, as defined by the [RECON software
lifecycle](https://www.reconverse.org/lifecycle.html).


### Contributions
Expand All @@ -65,4 +67,4 @@ Contributions are welcome via [pull requests](https://github.com/{{ gh_repo }}/p

Please note that the {{ packagename }} project is released with a
[Contributor Code of Conduct](https://github.com/epiverse-trace/.github/blob/main/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
By contributing to this project, you agree to abide by its terms.
Loading