Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
wlangera committed Sep 22, 2023
0 parents commit 921cf36
Show file tree
Hide file tree
Showing 9 changed files with 331 additions and 0 deletions.
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 behaviour 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 behaviour 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 `roxygen2` 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 [reproducible example](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
17 changes: 17 additions & 0 deletions .github/workflows/check_project.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
on:
push:
branches-ignore:
- gh-pages

name: check-project

jobs:
check-src:
runs-on: ubuntu-latest
name: "check project with checklist"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: read
steps:
- uses: inbo/actions/check_project@main
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.DS_Store
.RData
.Renviron
.Rhistory
.Rproj.user
.Ruserdata
.httr-oauth
*.dbf
*.doc*
*.gddoc
*.gdsheet
*.gpkg
*.html
*.mdb
*.shp*
*.shx
*.xls*
*_files
docs
libs
output
renv/library
161 changes: 161 additions & 0 deletions LICENSE.md

Large diffs are not rendered by default.

30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!-- badges: start -->
![GitHub](https://img.shields.io/github/license//mbag-mas)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status//mbag-mas/check-project)
![GitHub repo size](https://img.shields.io/github/repo-size//mbag-mas)
<!-- badges: end -->

# MBAG - MAS (akkervogels)

[Langeraert, Ward![ORCID logo](https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png)](https://orcid.org/0000-0002-5900-8109)[^aut][^cre][^inbo.be]
[Cartuyvels, Emma![ORCID logo](https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png)](https://orcid.org/0000-0001-7856-6360)[^aut][^inbo.be]
[Van Calster, Hans![ORCID logo](https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png)](https://orcid.org/0000-0001-8595-8426)[^aut][^inbo.be]
Research Institute for Nature and Forest (INBO)[^cph][^fnd]

[^cph]: copyright holder
[^fnd]: funder
[^aut]: author
[^cre]: contact person
[^inbo.be]: Instituut voor Natuur- en Bosonderzoek (INBO)

**keywords**: MBAG, MAS, akkervogels, biodiversiteit, beheerovereenkomsten, meetnet

<!-- community: inbo -->

<!-- description: start -->
Replace this with a short description of the project.
It becomes the abstract of the project in the citation information.
And the project description at https://zenodo.org
<!-- description: end -->

Anything below here is visible in the README but not in the citation.
18 changes: 18 additions & 0 deletions checklist.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
description: Configuration file for checklist::check_pkg()
package: no
allowed:
warnings: []
notes: []
required:
- CITATION
- checklist
- filename conventions
- folder conventions
- license
- lintr
- spelling
spelling:
default: nl-BE
ignore:
- .github
- LICENSE.md
17 changes: 17 additions & 0 deletions mbag-mas.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Version: 1.0

RestoreWorkspace: No
SaveWorkspace: No
AlwaysSaveHistory: No

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: knitr
LaTeX: XeLaTeX

AutoAppendNewline: Yes
StripTrailingWhitespace: Yes
LineEndingConversion: Posix
2 changes: 2 additions & 0 deletions source/checklist.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
library(checklist)
check_project()

0 comments on commit 921cf36

Please sign in to comment.