From ad9f55f0364de8c0fe5113865f24925ad4cd400c Mon Sep 17 00:00:00 2001 From: eduardklap Date: Sat, 8 Jun 2024 20:42:48 +0200 Subject: [PATCH] add citation.cff file and automation --- .Rbuildignore | 1 + .github/workflows/update-citation-cff.yaml | 58 ++++ CITATION.cff | 298 +++++++++++++++++++++ 3 files changed, 357 insertions(+) create mode 100644 .github/workflows/update-citation-cff.yaml create mode 100644 CITATION.cff diff --git a/.Rbuildignore b/.Rbuildignore index 37604cf..a4aed90 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,4 @@ ^pkgdown$ ^doc$ ^Meta$ +^CITATION\.cff$ diff --git a/.github/workflows/update-citation-cff.yaml b/.github/workflows/update-citation-cff.yaml new file mode 100644 index 0000000..54b01d6 --- /dev/null +++ b/.github/workflows/update-citation-cff.yaml @@ -0,0 +1,58 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/master/examples +# The action runs when: +# - A new release is published +# - The DESCRIPTION or inst/CITATION are modified +# - Can be run manually +# For customizing the triggers, visit https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +on: + release: + types: [published] + push: + branches: [master, main] + paths: + - DESCRIPTION + - inst/CITATION + workflow_dispatch: + +name: Update CITATION.cff + +jobs: + update-citation-cff: + runs-on: macos-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v3 + - uses: r-lib/actions/setup-r@v2 + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: | + any::cffr + any::V8 + + - name: Update CITATION.cff + run: | + + library(cffr) + + # Customize with your own code + # See https://docs.ropensci.org/cffr/articles/cffr.html + + # Write your own keys + mykeys <- list() + + # Create your CITATION.cff file + cff_write(keys = mykeys) + + shell: Rscript {0} + + - name: Commit results + run: | + git config --local user.name "github-actions[bot]" + git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com" + git add CITATION.cff + git commit -m 'Update CITATION.cff' || echo "No changes to commit" + git push origin || echo "No changes to commit" + + + diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..40c37e6 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,298 @@ +# -------------------------------------------- +# CITATION file created with {cffr} R package +# See also: https://docs.ropensci.org/cffr/ +# -------------------------------------------- + +cff-version: 1.2.0 +message: 'To cite package "neuroUp" in publications use:' +type: software +license: MIT +title: 'neuroUp: Plan Sample Size for fMRI Regions of Interest research using Bayesian + updating' +version: 0.2.0 +doi: 10.5281/zenodo.11526169 +abstract: The package calculates the precision in mean differences (raw or Cohen's + D) and correation coefficients for different sample sizes using permutations of + the collected data. +authors: +- family-names: Klapwijk + given-names: Eduard + email: et.klapwijk@gmail.com + orcid: https://orcid.org/0000-0002-8936-0365 +- family-names: Hoijtink + given-names: Herbert + orcid: https://orcid.org/0000-0001-8509-1973 +- family-names: Jongerling + given-names: Joran + orcid: https://orcid.org/0000-0001-5697-1381 +preferred-citation: + type: generic + title: 'neuroUp: Plan sample size for fMRI regions of interest research using Bayesian + updating' + authors: + - family-names: Klapwijk + given-names: Eduard + email: et.klapwijk@gmail.com + orcid: https://orcid.org/0000-0002-8936-0365 + - name: Hoijtink + - name: Herbert + - name: Jongerling + - name: Joran + year: '2024' + doi: 10.5281/zenodo.11526169 +url: https://eduardklap.github.io/neuroUp/ +contact: +- family-names: Klapwijk + given-names: Eduard + email: et.klapwijk@gmail.com + orcid: https://orcid.org/0000-0002-8936-0365 +references: +- type: software + title: dplyr + abstract: 'dplyr: A Grammar of Data Manipulation' + notes: Imports + url: https://dplyr.tidyverse.org + repository: https://CRAN.R-project.org/package=dplyr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: François + given-names: Romain + orcid: https://orcid.org/0000-0002-2444-4226 + - family-names: Henry + given-names: Lionel + - family-names: Müller + given-names: Kirill + orcid: https://orcid.org/0000-0002-1416-3412 + - family-names: Vaughan + given-names: Davis + email: davis@posit.co + orcid: https://orcid.org/0000-0003-4777-038X + year: '2024' +- type: software + title: rlang + abstract: 'rlang: Functions for Base Types and Core R and ''Tidyverse'' Features' + notes: Imports + url: https://rlang.r-lib.org + repository: https://CRAN.R-project.org/package=rlang + authors: + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2024' +- type: software + title: ggplot2 + abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics' + notes: Imports + url: https://ggplot2.tidyverse.org + repository: https://CRAN.R-project.org/package=ggplot2 + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: Chang + given-names: Winston + orcid: https://orcid.org/0000-0002-1576-2126 + - family-names: Henry + given-names: Lionel + - family-names: Pedersen + given-names: Thomas Lin + email: thomas.pedersen@posit.co + orcid: https://orcid.org/0000-0002-5147-4711 + - family-names: Takahashi + given-names: Kohske + - family-names: Wilke + given-names: Claus + orcid: https://orcid.org/0000-0002-7470-9261 + - family-names: Woo + given-names: Kara + orcid: https://orcid.org/0000-0002-5125-4188 + - family-names: Yutani + given-names: Hiroaki + orcid: https://orcid.org/0000-0002-3385-7233 + - family-names: Dunnington + given-names: Dewey + orcid: https://orcid.org/0000-0002-9415-4582 + - family-names: Brand + given-names: Teun + name-particle: van den + orcid: https://orcid.org/0000-0002-9335-7468 + year: '2024' +- type: software + title: psychometric + abstract: 'psychometric: Applied Psychometric Theory' + notes: Imports + repository: https://CRAN.R-project.org/package=psychometric + authors: + - family-names: Fletcher + given-names: Thomas D. + year: '2024' +- type: software + title: tibble + abstract: 'tibble: Simple Data Frames' + notes: Imports + url: https://tibble.tidyverse.org/ + repository: https://CRAN.R-project.org/package=tibble + authors: + - family-names: Müller + given-names: Kirill + email: kirill@cynkra.com + orcid: https://orcid.org/0000-0002-1416-3412 + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + year: '2024' +- type: software + title: magrittr + abstract: 'magrittr: A Forward-Pipe Operator for R' + notes: Imports + url: https://magrittr.tidyverse.org + repository: https://CRAN.R-project.org/package=magrittr + authors: + - family-names: Bache + given-names: Stefan Milton + email: stefan@stefanbache.dk + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + year: '2024' +- type: software + title: bootstrap + abstract: 'bootstrap: Functions for the Book "An Introduction to the Bootstrap"' + notes: Imports + url: https://gitlab.com/scottkosty/bootstrap + repository: https://CRAN.R-project.org/package=bootstrap + authors: + - family-names: original + given-names: S + - family-names: StatLib + given-names: from + - family-names: Leisch. + given-names: by Rob Tibshirani. R port by Friedrich + year: '2024' +- type: software + title: knitr + abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R' + notes: Suggests + url: https://yihui.org/knitr/ + repository: https://CRAN.R-project.org/package=knitr + authors: + - family-names: Xie + given-names: Yihui + email: xie@yihui.name + orcid: https://orcid.org/0000-0003-0645-5666 + year: '2024' +- type: software + title: readr + abstract: 'readr: Read Rectangular Text Data' + notes: Suggests + url: https://readr.tidyverse.org + repository: https://CRAN.R-project.org/package=readr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + - family-names: Hester + given-names: Jim + - family-names: Bryan + given-names: Jennifer + email: jenny@posit.co + orcid: https://orcid.org/0000-0002-6983-2759 + year: '2024' +- type: software + title: rmarkdown + abstract: 'rmarkdown: Dynamic Documents for R' + notes: Suggests + url: https://pkgs.rstudio.com/rmarkdown/ + repository: https://CRAN.R-project.org/package=rmarkdown + authors: + - family-names: Allaire + given-names: JJ + email: jj@posit.co + - family-names: Xie + given-names: Yihui + email: xie@yihui.name + orcid: https://orcid.org/0000-0003-0645-5666 + - family-names: Dervieux + given-names: Christophe + email: cderv@posit.co + orcid: https://orcid.org/0000-0003-4474-2498 + - family-names: McPherson + given-names: Jonathan + email: jonathan@posit.co + - family-names: Luraschi + given-names: Javier + - family-names: Ushey + given-names: Kevin + email: kevin@posit.co + - family-names: Atkins + given-names: Aron + email: aron@posit.co + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + - family-names: Cheng + given-names: Joe + email: joe@posit.co + - family-names: Chang + given-names: Winston + email: winston@posit.co + - family-names: Iannone + given-names: Richard + email: rich@posit.co + orcid: https://orcid.org/0000-0003-3925-190X + year: '2024' +- type: software + title: testthat + abstract: 'testthat: Unit Testing for R' + notes: Suggests + url: https://testthat.r-lib.org + repository: https://CRAN.R-project.org/package=testthat + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2024' + version: '>= 3.0.0' +- type: software + title: vdiffr + abstract: 'vdiffr: Visual Regression Testing and Graphical Diffing' + notes: Suggests + url: https://vdiffr.r-lib.org/ + repository: https://CRAN.R-project.org/package=vdiffr + authors: + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + - family-names: Pedersen + given-names: Thomas Lin + email: thomas.pedersen@posit.co + orcid: https://orcid.org/0000-0002-5147-4711 + - family-names: Luciani + given-names: T Jake + email: jake@apache.org + - family-names: Decorde + given-names: Matthieu + email: matthieu.decorde@ens-lyon.fr + - family-names: Lise + given-names: Vaudor + email: lise.vaudor@ens-lyon.fr + year: '2024' +- type: software + title: 'R: A Language and Environment for Statistical Computing' + notes: Depends + url: https://www.R-project.org/ + authors: + - name: R Core Team + institution: + name: R Foundation for Statistical Computing + address: Vienna, Austria + year: '2024' + version: '>= 2.10' +