Skip to content

Commit

Permalink
Merge pull request #40 from inbo/netlify
Browse files Browse the repository at this point in the history
use checklist
  • Loading branch information
ThierryO authored Feb 3, 2022
2 parents 8ab636a + 3e6cdd5 commit 3eb0e9d
Show file tree
Hide file tree
Showing 76 changed files with 3,619 additions and 2,718 deletions.
34 changes: 23 additions & 11 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
^appveyor\.yml$
^wercker\.yml$
.*_cache$
^_builds$
^_pkgdown.yml$
^_projects$
^_steps$
^.*\.png$
^.*\.Rproj$
^\.Rproj\.user$
^\.lintr$
^\.git$
^\.github$
^\.httr-oauth$
^\.lintr$
^\.Rproj\.user$
^\.travis\.yml$
^.*\.png$
^README\.Rmd$
^\.zenodo\.json$
^appveyor\.yml$
^checklist.yml$
^CITATION\.cff$
^CODE_OF_CONDUCT\.md$
^codecov\.yml$
^data-raw$
^docs$
^LICENSE.md$
^man-roxygen$
^man\-roxygen$
.*_cache$
^_projects$
^_builds$
^_steps$
^NEWS\.md$
^CODE_OF_CONDUCT\.md$
^pkgdown$
^README\.Rmd$
^wercker\.yml$
CONTRIBUTING.md
25 changes: 25 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http://contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
39 changes: 39 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# CONTRIBUTING #

### Fixing typos

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the _source_ file.
E.g. edit a roxygen comment in a `.R` file below `R/`, not in an `.Rd` file below `man/`.

### Prerequisites

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem.
If you’ve found a bug, create an associated issue and illustrate the bug with a minimal [reprex](https://www.tidyverse.org/help/#reprex).

### Pull request process

* We recommend that you create a Git branch for each pull request (PR).
* Look at the GitHub Actions build status before and after making changes.
The `README` should contain badges for any continuous integration services used by the package.
* We require the tidyverse [style guide](http://style.tidyverse.org).
You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR.
* We use [roxygen2](https://cran.r-project.org/package=roxygen2).
* We use [testthat](https://cran.r-project.org/package=testthat).
Contributions with test cases included are easier to accept.
* For user-facing changes, add a bullet to the top of `NEWS.md` below the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).

### Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By contributing to this project you agree to abide by its terms.

### Prefer to Email?

Email the person listed as maintainer in the `DESCRIPTION` file of this repo.

Though note that private discussions over email don't help others - of course
email is totally warranted if it's a sensitive problem of any kind.

### Thanks for contributing!

This contributing guide is adapted from the tidyverse contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md
20 changes: 20 additions & 0 deletions .github/workflows/check_on_branch.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
on:
push:
branches-ignore:
- main
- master
- ghpages

name: "check package"

jobs:
check-package:
runs-on: ubuntu-latest
name: "check package"
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
ORCID_TOKEN: ${{ secrets.ORCID_TOKEN }}
steps:
- uses: inbo/actions/check_pkg@master
with:
token: ${{ secrets.PAT }}
98 changes: 98 additions & 0 deletions .github/workflows/check_on_different_r_os.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
on:
push:
branches:
- main
- master
pull_request:
branches:
- main
- master

name: R-CMD-check-OS

jobs:
R-CMD-check:
runs-on: ${{ matrix.config.os }}

name: ${{ matrix.config.os }} (${{ matrix.config.r }})

strategy:
fail-fast: false
matrix:
config:
- {os: macOS-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: ubuntu-20.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
- {os: ubuntu-20.04, r: 'oldrel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}

env:
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
_R_CHECK_SYSTEM_CLOCK_: false
RSPM: ${{ matrix.config.rspm }}
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
ORCID_TOKEN: ${{ secrets.ORCID_TOKEN }}

steps:
- uses: actions/checkout@v2

- uses: r-lib/actions/setup-r@master
with:
r-version: ${{ matrix.config.r }}

- uses: r-lib/actions/setup-pandoc@master

- name: Query dependencies
run: |
install.packages('remotes')
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
shell: Rscript {0}

- name: Cache R packages
if: runner.os != 'Windows'
uses: actions/cache@v1
with:
path: ${{ env.R_LIBS_USER }}
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-

- name: Install system dependencies
if: runner.os == 'Linux'
env:
RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
run: |
Rscript -e "remotes::install_github('r-hub/sysreqs')"
sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
sudo -s eval "$sysreqs"
- name: Install dependencies
run: |
remotes::install_deps(dependencies = TRUE)
remotes::install_cran("rcmdcheck")
shell: Rscript {0}

- name: Session info
run: |
options(width = 100)
pkgs <- installed.packages()[, "Package"]
sessioninfo::session_info(pkgs, include_base = TRUE)
shell: Rscript {0}

- name: Check
env:
_R_CHECK_CRAN_INCOMING_: false
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "error", check_dir = "check")
shell: Rscript {0}

- name: Show testthat output
if: always()
run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true
shell: bash

- name: Upload check results
if: failure()
uses: actions/upload-artifact@master
with:
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
path: check
retention-days: 5
21 changes: 21 additions & 0 deletions .github/workflows/check_on_main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
on:
push:
branches:
- main
- master
schedule:
- cron: '6 0 15 * *'

name: "check package on main"

jobs:
check-package:
runs-on: ubuntu-latest
name: "check package"
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
ORCID_TOKEN: ${{ secrets.ORCID_TOKEN }}
steps:
- uses: inbo/actions/check_pkg@master
with:
token: ${{ secrets.PAT }}
30 changes: 30 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
on:
push:
tags:
- 'v*'

name: Create Release

jobs:
build:
name: Create Release
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Get tag message
run: |
TAG_BODY=$(git tag --contains ${{ github.sha }} -n100 | awk '(NR>1)')
echo "::set-output name=TAG_BODY::$TAG_BODY"
id: tag-body
- name: Create Release
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
release_name: Release ${{ github.ref }}
body: ${{ steps.tag-body.outputs.TAG_BODY }}
draft: false
prerelease: false
16 changes: 10 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
.Rproj.user
.Rhistory
.RData
inst/doc
*_cache
_projects
_builds
_projects
_steps
.httr-oauth
.RData
.Rhistory
.Rproj.user
.Ruserdata
*_cache
*.html
docs
inst/doc
1 change: 0 additions & 1 deletion .lintr

This file was deleted.

38 changes: 38 additions & 0 deletions .zenodo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"title": "multimput: Using Multiple Imputation to Address Missing Data",
"version": "0.2.10",
"description": "Accompaning package for the paper: \"Working with population totals in the presence of with missing data\".",
"creators": [
{
"name": "Onkelinx, Thierry",
"orcid": "https://orcid.org/0000-0001-8804-4216"
},
{
"name": "Devos, Koen",
"orcid": "https://orcid.org/0000-0001-7265-6349"
},
{
"name": "Quataert, Paul",
"orcid": "https://orcid.org/0000-0002-6894-9402"
}
],
"upload_type": "software",
"access_right": "open",
"license": "GPL-3.0",
"communities": [
{
"identifier": "inbo"
}
],
"contributors": [
{
"name": "Research Institute for Nature and Forest",
"type": "RightsHolder"
},
{
"name": "Onkelinx, Thierry",
"type": "ContactPerson",
"orcid": "https://orcid.org/0000-0001-8804-4216"
}
]
}
27 changes: 27 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
cff-version: 1.2.0
message: If you use this software, please cite it as below.
authors:
- family-names: Onkelinx
given-names: Thierry
orcid: https://orcid.org/0000-0001-8804-4216
- family-names: Devos
given-names: Koen
orcid: https://orcid.org/0000-0001-7265-6349
- family-names: Quataert
given-names: Paul
orcid: https://orcid.org/0000-0002-6894-9402
contact:
- email: [email protected]
family-names: Onkelinx
given-names: Thierry
- email: [email protected]
name: Research Institute for Nature and Forest
title: 'multimput: Using Multiple Imputation to Address Missing Data'
version: 0.2.10
abstract: 'Accompaning package for the paper: "Working with population totals in the
presence of with missing data".'
license: GPL-3.0
type: software
doi: 10.5281/zenodo.598331
repository-code: https://github.com/inbo/multimput
identifiers: []
Loading

0 comments on commit 3eb0e9d

Please sign in to comment.