Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/insightsengineering/r.pkg.template
An opinionated R package template with CI/CD built-in
https://github.com/insightsengineering/r.pkg.template
git github-actions r template
Last synced: 3 months ago
JSON representation
An opinionated R package template with CI/CD built-in
- Host: GitHub
- URL: https://github.com/insightsengineering/r.pkg.template
- Owner: insightsengineering
- License: other
- Created: 2021-07-05T21:42:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T18:18:49.000Z (4 months ago)
- Last Synced: 2024-07-19T01:17:25.647Z (4 months ago)
- Topics: git, github-actions, r, template
- Language: Shell
- Homepage: https://insightsengineering.github.io/r.pkg.template/
- Size: 3.44 MB
- Stars: 34
- Watchers: 19
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- top-pharma50 - **insightsengineering/r.pkg.template** - in<br>`git`, `github-actions`, `r`, `template`<br><img src='https://github.com/HubTou/topgh/blob/main/icons/gstars.png'> 31 <img src='https://github.com/HubTou/topgh/blob/main/icons/forks.png'> 7 <img src='https://github.com/HubTou/topgh/blob/main/icons/code.png'> Shell <img src='https://github.com/HubTou/topgh/blob/main/icons/license.png'> Other <img src='https://github.com/HubTou/topgh/blob/main/icons/last.png'> 2024-06-05 15:37:35 | (Ranked by starred repositories)
- top-pharma50 - **insightsengineering/r.pkg.template** - in<br>`git`, `github-actions`, `r`, `template`<br><img src='https://github.com/HubTou/topgh/blob/main/icons/gstars.png'> 31 <img src='https://github.com/HubTou/topgh/blob/main/icons/forks.png'> 7 <img src='https://github.com/HubTou/topgh/blob/main/icons/code.png'> Shell <img src='https://github.com/HubTou/topgh/blob/main/icons/license.png'> Other <img src='https://github.com/HubTou/topgh/blob/main/icons/last.png'> 2024-06-05 15:37:35 | (Ranked by starred repositories)
- jimsghstars - insightsengineering/r.pkg.template - An opinionated R package template with CI/CD built-in (Shell)
README
# r.pkg.template
[](https://www.repostatus.org/#active)
[](https://tooomm.github.io/github-release-stats/?username=insightsengineering\&repository=r.pkg.template)
[](https://github.com/insightsengineering/r.pkg.template/tree/main)
[](https://github.com/insightsengineering/r.pkg.template/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/audit.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/bioccheck.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/links.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/test-coverage.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/licenses.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/pkgdown.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/build-check-install.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/validation.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/release.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/roxygen.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/spelling.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/style.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/linter.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/version-bump.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/version.yaml)
[](https://github.com/insightsengineering/r.pkg.template/actions/workflows/gitleaks.yaml)
[pre-commit]: https://pre-commit.com
[pre-commit installation]: https://pre-commit.com/#installation
[git hooks]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
An R package template with built-in GitHub Actions-based CI/CD workflows.
## Usage
### Initialization
You could initialize this repository in one of two ways:
#### Clone this template
* Clone this repository:
```bash
git clone https://github.com/insightsengineering/r.pkg.template.git
cd r.pkg.template
```
* Run the initializer script:
```bash
./init.sh
```
#### Use GitHub's template importer
* Click [here](https://github.com/insightsengineering/r.pkg.template/generate) to generate a copy of this template directly within GitHub.
* Clone the repository from your account/organization.
* Run the initializer script:
```bash
./init.sh
```
### CI/CD Configurations
All CI/CD jobs are defined in the [.github/workflows](./.github/workflows) directory in the form of GitHub Action workflows. These can be modified per your requirements, but are designed and implemented to follow best practices and to ensure the highest quality standards for your package.
All workflows originating from this repository can be repurposed by other R package GitHub repositories.
👉 For more information including detailed description and screenshots of workflows, please refer to the [Workflows documentation](./workflows.md).
### Pre-commit
This repository contains an example [pre-commit] configuration.
[pre-commit] is a tool that uses [Git hooks] to identify and resolve simple issues before submission for code review.
[Git hooks] run on every commit to automatically point out and solve issues such as missing semicolons, trailing whitespaces,
code formatting and spell checks.
### Setting up pre-commit for R project
* Install the `pre-commit` framework. Use the official [installation guide][pre-commit installation].
* Install R package `precommit`
```sh
R -e 'install.packages("precommit")'
```
* Run the `use_precommit()` function to generate an example pre-commit configuration called `.pre-commit-config.yaml`:
```sh
[ ! -f ".pre-commit-config.yaml" ] && R -e 'precommit::use_precommit()'
```
* Install the git hooks script:
```sh
pre-commit install
```
* From this moment on, all scripts from `.pre-commit-config.yaml` will run before every `git commit` command. If you want to run them manually without committing you can use command `pre-commit run --all-files`. For more information, please refer to the official [pre-commit] documentation.
> NOTE: Frequently run `pre-commit autoupdate` to update all hooks in the `.pre-commit-config.yaml` configuration file.
### Example output from pre-commit
```sh
$ git add .
$ git commit -m "Add pre-commit configuration"
[INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
style-files..............................................................Passed
roxygenize...........................................(no files to check)Skipped
use-tidy-description.....................................................Passed
spell-check..............................................................Failed
- hook id: spell-check
- exit code: 1
- files were modified by this hook
The following spelling errors were found:
WORD FOUND IN
commiting README.md:77
indentify README.md:49
informatoin README.md:77
All spelling errors found were copied to inst/WORDLIST assuming they were not spelling errors and will be ignored in the future. Please review the above list and for each word that is an actual typo:
- fix it in the source code.
- remove it again manually from inst/WORDLIST to make sure it's not
ignored in the future.
Then, try committing again.
Error: Spell check failed
Execution halted
lintr....................................................................Passed
readme-rmd-rendered......................................................Passed
parsable-R...............................................................Passed
no-browser-statement.....................................................Passed
deps-in-desc.............................................................Passed
prettier.................................................................Failed
- hook id: prettier
- files were modified by this hook
.pre-commit-config.yaml
README.md
Check for added large files..............................................Passed
Fix End of Files.........................................................Passed
Trim Trailing Whitespace.................................................Failed
- hook id: trailing-whitespace
- exit code: 1
- files were modified by this hook
Fixing .pre-commit-config.yaml
Fixing README.md
Check Yaml...............................................................Passed
Don't commit to branch...................................................Passed
Mixed line ending........................................................Passed
Don't commit common R artifacts......................(no files to check)Skipped
```
## Stargazers and Forkers
### Stargazers over time
[](https://starchart.cc/insightsengineering/r.pkg.template)
### Stargazers
[](https://github.com/insightsengineering/r.pkg.template/stargazers)
### Forkers
[](https://github.com/insightsengineering/r.pkg.template/network/members)