https://github.com/anestistouloumis/r_package_info
Tools and information about developing and improving "good" R packages
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 1 committers (100.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.3%) to scientific vocabulary
Last synced: 10 months ago
·
JSON representation
Repository
Tools and information about developing and improving "good" R packages
Basic Info
- Host: GitHub
- Owner: AnestisTouloumis
- Default Branch: master
- Size: 3.91 KB
Statistics
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
- Releases: 0
Created almost 7 years ago
· Last pushed almost 7 years ago
Metadata Files
Readme
README.Rmd
---
title: "Automatic tools and information for creating and improving R packages"
output: github_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
This document relies heavily on two posts:
- [Automatic tools for improving R packages](https://www.r-bloggers.com/automatic-tools-for-improving-r-packages/)
- [How to develop good R packages (for open science)](https://www.r-bloggers.com/how-to-develop-good-r-packages-for-open-science/)
## Creating R package
- [Writing an R package from scratch](https://hilaryparker.com/2014/04/29/writing-an-r-package-from-scratch/)
- [R Package Development Pictorial](http://www.mjdenny.com/R_Package_Pictorial.html)
- [R-packages](http://r-pkgs.had.co.nz/) book by Hadley Wickham
- [MIT Step by Step Instructions for Creating Your Own R Package](http://web.mit.edu/insong/www/pdf/rpackage_instructions.pdf) by Kim, Martin, McMurry and Halterman
- R package [usethis](https://www.tidyverse.org/articles/2017/11/usethis-1.0.0/) automates several steps described in [R-packages](http://r-pkgs.had.co.nz/)
- [rOpenSci Packaging Guide](https://devguide.ropensci.org/building.html) by rOpenSci community
## Styling Code
- R package [lintr](https://github.com/jimhester/lintr) for static code analysis
- R package [style](https://github.com/r-lib/styler) or the R function `usethis::use_tidy_style()` to prettify code
Workflow:
```{r eval=FALSE}
usethis::use_tidy_style()
lintr::lint_package()
```
## Continuous Intergration
- [Travis CI guide](https://docs.travis-ci.com/user/languages/r/#configuration-options) by Travis-CI
- [Advanced guide](https://towardsdatascience.com/travis-ci-for-r-advanced-guide-719cb2d9e0e5) by Sebastian Wolf
Personal configuration for `.travis.yml` file:
```
language: r
r:
- oldrel
- release
- devel
r_github_packages:
- jimhester/lintr
after_success:
- R CMD INSTALL $PKG_TARBALL
- Rscript -e 'covr::codecov()'
- Rscript -e 'lintr::lint_package()'
```
## Spelling
- `devtools::spell_check`
- `spelling::spell_check_package`
Workflow:
```{r eval=FALSE}
devtools::spell_check(".")
spelling::spell_check_package(".")
```
## Automatic advice
- R package [`goodpractice`](https://cran.r-project.org/web/packages/goodpractice/index.html)
Workflow:
```{r eval=FALSE}
goodpractice::gp(".")
```
## Static html documentation
- R package [`pkgdown`](https://cran.r-project.org/web/packages/pkgbuild/index.html)
- `pkgdown` [tutorial](https://enpiar.com/2017/11/21/getting-down-with-pkgdown/)
```{r eval=FALSE}
pkgdown::init()
pkgdown::build_site()
```
## GitHub
- [Happy Git and GitHub for the useR](https://happygitwithr.com/)
Owner
- Name: Anestis Touloumis
- Login: AnestisTouloumis
- Kind: user
- Location: Brighton, UK
- Company: University of Brighton
- Website: https://research.brighton.ac.uk/en/persons/anestis-touloumis
- Twitter: anetouloumis
- Repositories: 20
- Profile: https://github.com/AnestisTouloumis
GitHub Events
Total
Last Year
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| AnestisTouloumis | A****s@b****k | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0