From 99722695d57f51a005223bac5daa3b5289819973 Mon Sep 17 00:00:00 2001 From: Peter Desmet Date: Wed, 6 Mar 2024 13:42:52 +0100 Subject: [PATCH 1/8] usethis::create_package("camtrapdp") --- .Rbuildignore | 2 ++ .gitignore | 1 + DESCRIPTION | 12 ++++++++++++ NAMESPACE | 2 ++ camtrapdp.Rproj | 22 ++++++++++++++++++++++ 5 files changed, 39 insertions(+) create mode 100644 .Rbuildignore create mode 100644 DESCRIPTION create mode 100644 NAMESPACE create mode 100644 camtrapdp.Rproj diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 00000000..2c086788 --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,2 @@ +^camtrapdp\.Rproj$ +^\.Rproj\.user$ diff --git a/.gitignore b/.gitignore index e75435c1..7cc8b6a3 100644 --- a/.gitignore +++ b/.gitignore @@ -47,3 +47,4 @@ po/*~ # RStudio Connect folder rsconnect/ +.Rproj.user diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 00000000..f83a4748 --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,12 @@ +Package: camtrapdp +Title: What the Package Does (One Line, Title Case) +Version: 0.0.0.9000 +Authors@R: + person("First", "Last", , "first.last@example.com", role = c("aut", "cre"), + comment = c(ORCID = "YOUR-ORCID-ID")) +Description: What the package does (one paragraph). +License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a + license +Encoding: UTF-8 +Roxygen: list(markdown = TRUE) +RoxygenNote: 7.3.0 diff --git a/NAMESPACE b/NAMESPACE new file mode 100644 index 00000000..6ae92683 --- /dev/null +++ b/NAMESPACE @@ -0,0 +1,2 @@ +# Generated by roxygen2: do not edit by hand + diff --git a/camtrapdp.Rproj b/camtrapdp.Rproj new file mode 100644 index 00000000..69fafd4b --- /dev/null +++ b/camtrapdp.Rproj @@ -0,0 +1,22 @@ +Version: 1.0 + +RestoreWorkspace: No +SaveWorkspace: No +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 2 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: pdfLaTeX + +AutoAppendNewline: Yes +StripTrailingWhitespace: Yes +LineEndingConversion: Posix + +BuildType: Package +PackageUseDevtools: Yes +PackageInstallArgs: --no-multiarch --with-keep.source +PackageRoxygenize: rd,collate,namespace From 1fca5f7c7c0ea2c00b0acc64c05a1b1f041fd796 Mon Sep 17 00:00:00 2001 From: Peter Desmet Date: Wed, 6 Mar 2024 13:44:13 +0100 Subject: [PATCH 2/8] Set license usethis::use_mit_license(copyright_holder = "Research Institute for Nature and Forest (INBO)") --- .Rbuildignore | 1 + DESCRIPTION | 3 +-- LICENSE | 23 ++--------------------- LICENSE.md | 21 +++++++++++++++++++++ 4 files changed, 25 insertions(+), 23 deletions(-) create mode 100644 LICENSE.md diff --git a/.Rbuildignore b/.Rbuildignore index 2c086788..f65a10cb 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,2 +1,3 @@ ^camtrapdp\.Rproj$ ^\.Rproj\.user$ +^LICENSE\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index f83a4748..4e427040 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -5,8 +5,7 @@ Authors@R: person("First", "Last", , "first.last@example.com", role = c("aut", "cre"), comment = c(ORCID = "YOUR-ORCID-ID")) Description: What the package does (one paragraph). -License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a - license +License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.0 diff --git a/LICENSE b/LICENSE index 90975aaf..2c338f8e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,2 @@ -MIT License - -Copyright (c) 2024 Research Institute for Nature and Forest (INBO) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +YEAR: 2024 +COPYRIGHT HOLDER: Research Institute for Nature and Forest (INBO) diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..66c961a9 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2024 Research Institute for Nature and Forest (INBO) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 1827461b0cd70b1d77908015d522b9ca4c3f8f12 Mon Sep 17 00:00:00 2001 From: Peter Desmet Date: Wed, 6 Mar 2024 13:46:10 +0100 Subject: [PATCH 3/8] usethis::use_tidy_coc() --- .DS_Store | Bin 0 -> 6148 bytes .github/CODE_OF_CONDUCT.md | 126 +++++++++++++++++++++++++++++++++++++ 2 files changed, 126 insertions(+) create mode 100644 .DS_Store create mode 100644 .github/CODE_OF_CONDUCT.md diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..9c7e095a39565e9fec75f52b03c6c0fb8e8f112e GIT binary patch literal 6148 zcmeHKOG-mQ5Uh>?1KDKha!w$4gCQg*$OR+_QIH5?vVNBc8SOA#O9dYt7Ha~YC*`zW?r1Oqv9I!oZ-uJI>qw4Dk=icHTJG|iI zJAc2+Td&iUl>$;g3P=GdAO(J@fcIY7Y@Vnn1*Cu!I4j`ahemhog+pR|Iv8REAWoSM z<2q&uV)F#C7Y>Qc&@8FMq*{#_mUQM@)%C(5G3l@xKCGT>HKABMo%gpWhxJ57DIf(d z6}ZXm!u$W4{=@u#NzzUVNP&N)fK6AM)snANy>;|*-fJ8Ek?u90bT_Vp!VvA4810xF fZ^w60ly%M5Jnw}=V$hinI#E9Zu8T|x{IvpK{InHg literal 0 HcmV?d00001 diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..3ac34c82 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,126 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at codeofconduct@posit.co. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion]. + +For answers to common questions about this code of conduct, see the FAQ at +. Translations are available at . + +[homepage]: https://www.contributor-covenant.org From d0f3fec2ff34c4a05c49378279ad1495ad872113 Mon Sep 17 00:00:00 2001 From: Peter Desmet Date: Wed, 6 Mar 2024 13:50:24 +0100 Subject: [PATCH 4/8] Add CONTRIBUTING.md usethis::use_tidy_contributing() Then replace with https://gist.github.com/peterdesmet/e90a1b0dc17af6c12daf6e8b2f044e7c --- .Rbuildignore | 1 + .github/CONTRIBUTING.md | 86 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.Rbuildignore b/.Rbuildignore index f65a10cb..28826c54 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,4 @@ ^camtrapdp\.Rproj$ ^\.Rproj\.user$ ^LICENSE\.md$ +^\.github$ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..167ca07d --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,86 @@ +# Contributing to camtrapdp + + + +First of all, thanks for considering contributing to camtrapdp! 👍 It's people like you that make it rewarding for us - the project maintainers - to work on camtrapdp. 😊 + +camtrapdp is an open source project, maintained by people who care. We are not directly funded to do so. + +[repo]: https://github.com/inbo/camtrapdp +[issues]: https://github.com/inbo/camtrapdp/issues +[new_issue]: https://github.com/inbo/camtrapdp/issues/new +[website]: https://inbo.github.io/camtrapdp +[citation]: https://inbo.github.io/camtrapdp/authors.html +[email]: mailto:damiano.oldoni@inbo.be + +## Code of conduct + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. + +## How you can contribute + +There are several ways you can contribute to this project. If you want to know more about why and how to contribute to open source projects like this one, see this [Open Source Guide](https://opensource.guide/how-to-contribute/). + +### Share the love ❤️ + +Think camtrapdp is useful? Let others discover it, by telling them in person, via Twitter or a blog post. + +Using camtrapdp for a paper you are writing? Consider [citing it][citation]. + +### Ask a question ⁉️ + +Using camtrapdp and got stuck? Browse the [documentation][website] to see if you can find a solution. Still stuck? Post your question as an [issue on GitHub][new_issue]. While we cannot offer user support, we'll try to do our best to address it, as questions often lead to better documentation or the discovery of bugs. + +Want to ask a question in private? Contact the package maintainer by [email][mailto:email]. + +### Propose an idea 💡 + +Have an idea for a new camtrapdp feature? Take a look at the [documentation][website] and [issue list][issues] to see if it isn't included or suggested yet. If not, suggest your idea as an [issue on GitHub][new_issue]. While we can't promise to implement your idea, it helps to: + +* Explain in detail how it would work. +* Keep the scope as narrow as possible. + +See below if you want to contribute code for your idea as well. + +### Report a bug 🐛 + +Using camtrapdp and discovered a bug? That's annoying! Don't let others have the same experience and report it as an [issue on GitHub][new_issue] so we can fix it. A good bug report makes it easier for us to do so, so please include: + +* Your operating system name and version (e.g. Mac OS 10.13.6). +* Any details about your local setup that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. + +### Improve the documentation 📖 + +Noticed a typo on the website? Think a function could use a better example? Good documentation makes all the difference, so your help to improve it is very welcome! + +#### The website + +[This website][website] is generated with [`pkgdown`](http://pkgdown.r-lib.org/). That means we don't have to write any html: content is pulled together from documentation in the code, vignettes, [Markdown](https://guides.github.com/features/mastering-markdown/) files, the package `DESCRIPTION` and `_pkgdown.yml` settings. If you know your way around `pkgdown`, you can [propose a file change](https://help.github.com/articles/editing-files-in-another-user-s-repository/) to improve documentation. If not, [report an issue][new_issue] and we can point you in the right direction. + +#### Function documentation + +Functions are described as comments near their code and translated to documentation using [`roxygen2`](https://klutometis.github.io/roxygen/). If you want to improve a function description: + +1. Go to `R/` directory in the [code repository][repo]. +2. Look for the file with the name of the function. +3. [Propose a file change](https://help.github.com/articles/editing-files-in-another-user-s-repository/) to update the function documentation in the roxygen comments (starting with `#'`). + +### Contribute code 📝 + +Care to fix bugs or implement new functionality for camtrapdp? Awesome! 👏 Have a look at the [issue list][issues] and leave a comment on the things you want to work on. See also the development guidelines below. + +## Development guidelines + +We try to follow the [GitHub flow](https://guides.github.com/introduction/flow/) for development. + +1. Fork [this repo][repo] and clone it to your computer. To learn more about this process, see [this guide](https://guides.github.com/activities/forking/). +2. If you have forked and cloned the project before and it has been a while since you worked on it, [pull changes from the original repo](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/) to your clone by using `git pull upstream master`. +3. Open the RStudio project file (`.Rproj`). +4. Make your changes: + * Write your code. + * Test your code (bonus points for adding unit tests). + * Document your code (see function documentation above). + * Check your code with `devtools::check()` and aim for 0 errors and warnings. +5. Commit and push your changes. +6. Submit a [pull request](https://guides.github.com/activities/forking/#making-a-pull-request). From 4399b9189880be13b4827ce743a7be25ecbbf7d3 Mon Sep 17 00:00:00 2001 From: Peter Desmet Date: Wed, 6 Mar 2024 13:52:49 +0100 Subject: [PATCH 5/8] usethis::use_readme_rmd() Adapt and do devtools::build_readme() --- .Rbuildignore | 1 + README.Rmd | 32 ++++++++++++++++++++++++++++++++ README.md | 22 +++++++++++++++++++++- 3 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 README.Rmd diff --git a/.Rbuildignore b/.Rbuildignore index 28826c54..8617ec08 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -2,3 +2,4 @@ ^\.Rproj\.user$ ^LICENSE\.md$ ^\.github$ +^README\.Rmd$ diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 00000000..17296f2d --- /dev/null +++ b/README.Rmd @@ -0,0 +1,32 @@ +--- +output: github_document +--- + + + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>", + fig.path = "man/figures/README-", + out.width = "100%" +) +``` + +# camtrapdp + + +[![R-CMD-check](https://github.com/inbo/camtrapdp/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/inbo/camtrapdp/actions/workflows/R-CMD-check.yaml) +[![test-coverage](https://github.com/inbo/camtrapdp/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/inbo/camtrapdp/actions/workflows/test-coverage.yaml) + + +The goal of camtrapdp is to ... + +## Installation + +You can install the development version of camtrapdp from [GitHub](https://github.com/) with: + +``` r +# install.packages("devtools") +devtools::install_github("inbo/camtrapdp") +``` diff --git a/README.md b/README.md index 71074122..bfa2325c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ + + + # camtrapdp -R package to read and convert Camera Trap Data Packages (Camtrap DP) + + + +[![R-CMD-check](https://github.com/inbo/camtrapdp/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/inbo/camtrapdp/actions/workflows/R-CMD-check.yaml) +[![test-coverage](https://github.com/inbo/camtrapdp/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/inbo/camtrapdp/actions/workflows/test-coverage.yaml) + + +The goal of camtrapdp is to … + +## Installation + +You can install the development version of camtrapdp from +[GitHub](https://github.com/) with: + +``` r +# install.packages("devtools") +devtools::install_github("inbo/camtrapdp") +``` From 995f61b05c224c56682c933b0cd7075f948f7c78 Mon Sep 17 00:00:00 2001 From: Peter Desmet Date: Wed, 6 Mar 2024 13:53:02 +0100 Subject: [PATCH 6/8] Add actions usethis::use_github_action("check-standard", badge = TRUE) usethis::use_github_action("test-coverage", badge = TRUE) --- .github/workflows/R-CMD-check.yaml | 50 ++++++++++++++++++++++++++++ .github/workflows/test-coverage.yaml | 50 ++++++++++++++++++++++++++++ 2 files changed, 100 insertions(+) create mode 100644 .github/workflows/R-CMD-check.yaml create mode 100644 .github/workflows/test-coverage.yaml diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 00000000..14159b77 --- /dev/null +++ b/.github/workflows/R-CMD-check.yaml @@ -0,0 +1,50 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +name: R-CMD-check + +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-latest, r: 'devel', http-user-agent: 'release'} + - {os: ubuntu-latest, r: 'release'} + - {os: ubuntu-latest, r: 'oldrel-1'} + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.config.r }} + http-user-agent: ${{ matrix.config.http-user-agent }} + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::rcmdcheck + needs: check + + - uses: r-lib/actions/check-r-package@v2 + with: + upload-snapshots: true + build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")' diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml new file mode 100644 index 00000000..21b8a933 --- /dev/null +++ b/.github/workflows/test-coverage.yaml @@ -0,0 +1,50 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +name: test-coverage + +jobs: + test-coverage: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::covr + needs: coverage + + - name: Test coverage + run: | + covr::codecov( + quiet = FALSE, + clean = FALSE, + install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package") + ) + shell: Rscript {0} + + - name: Show testthat output + if: always() + run: | + ## -------------------------------------------------------------------- + find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true + shell: bash + + - name: Upload test results + if: failure() + uses: actions/upload-artifact@v4 + with: + name: coverage-test-failures + path: ${{ runner.temp }}/package From 412547772ad63f11d5f569a67c371a3cdcb5dcbd Mon Sep 17 00:00:00 2001 From: Peter Desmet Date: Wed, 6 Mar 2024 13:54:35 +0100 Subject: [PATCH 7/8] Start first function + tests usethis::use_r("read_camtrap_dp") usethis::use_testthat() usethis::use_test() devtools::document() devtools::test() --- DESCRIPTION | 3 +++ R/read_camtrap_dp.R | 0 tests/testthat.R | 12 ++++++++++++ tests/testthat/test-read_camtrap_dp.R | 3 +++ 4 files changed, 18 insertions(+) create mode 100644 R/read_camtrap_dp.R create mode 100644 tests/testthat.R create mode 100644 tests/testthat/test-read_camtrap_dp.R diff --git a/DESCRIPTION b/DESCRIPTION index 4e427040..9b6b231b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -9,3 +9,6 @@ License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.0 +Suggests: + testthat (>= 3.0.0) +Config/testthat/edition: 3 diff --git a/R/read_camtrap_dp.R b/R/read_camtrap_dp.R new file mode 100644 index 00000000..e69de29b diff --git a/tests/testthat.R b/tests/testthat.R new file mode 100644 index 00000000..3042ce93 --- /dev/null +++ b/tests/testthat.R @@ -0,0 +1,12 @@ +# This file is part of the standard setup for testthat. +# It is recommended that you do not modify it. +# +# Where should you do additional test configuration? +# Learn more about the roles of various files in: +# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview +# * https://testthat.r-lib.org/articles/special-files.html + +library(testthat) +library(camtrapdp) + +test_check("camtrapdp") diff --git a/tests/testthat/test-read_camtrap_dp.R b/tests/testthat/test-read_camtrap_dp.R new file mode 100644 index 00000000..8849056e --- /dev/null +++ b/tests/testthat/test-read_camtrap_dp.R @@ -0,0 +1,3 @@ +test_that("multiplication works", { + expect_equal(2 * 2, 4) +}) From ba34a72eb20c48639bc273e6756f40327fe61293 Mon Sep 17 00:00:00 2001 From: Peter Desmet Date: Wed, 6 Mar 2024 13:57:43 +0100 Subject: [PATCH 8/8] Add title and @damianooldoni as contributor --- DESCRIPTION | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 9b6b231b..ac4c3004 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,9 +1,14 @@ Package: camtrapdp -Title: What the Package Does (One Line, Title Case) +Title: Read and Convert Camera Trap Data Packages (Camtrap DP) Version: 0.0.0.9000 -Authors@R: - person("First", "Last", , "first.last@example.com", role = c("aut", "cre"), - comment = c(ORCID = "YOUR-ORCID-ID")) +Authors@R: c( + person("Damiano", "Oldoni", email = "damiano.oldoni@inbo.be", + role = c("aut", "cre"), comment = c(ORCID = "0000-0003-3445-7562")), + person("Research Institute for Nature and Forest (INBO)", + role = "cph", comment = "https://www.vlaanderen.be/inbo/en-gb/"), + person("LifeWatch Belgium", + role = "fnd", comment = "https://lifewatch.be") + ) Description: What the package does (one paragraph). License: MIT + file LICENSE Encoding: UTF-8