diff --git a/.Rbuildignore b/.Rbuildignore index d30899e..f61708e 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,3 +3,4 @@ ^README\.Rmd$ ^LICENSE\.md$ ^\.github$ +^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..d643976 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,188 @@ +# ----------------------------------------------------------- +# CITATION file created with {cffr} R package, v0.5.0 +# See also: https://docs.ropensci.org/cffr/ +# ----------------------------------------------------------- + +cff-version: 1.2.0 +message: 'To cite package "CPTrackR" in publications use:' +type: software +license: MIT +title: 'CPTrackR: Create unique track identifiers for CellProfiler tracking output' +version: 0.2.2.9000 +abstract: Create unique track identifiers for CellProfiler tracking output. +authors: +- family-names: Burger + given-names: Gerhard + email: burger.ga@gmail.com + orcid: https://orcid.org/0000-0003-1062-5576 +- family-names: Heldring + given-names: Muriel + email: murielheldring@gmail.com + orcid: https://orcid.org/0000-0002-3565-7227 +- family-names: Wink + given-names: Steven + email: hardervidertsie@gmail.com + orcid: https://orcid.org/0000-0003-1189-7231 +contact: +- family-names: Burger + given-names: Gerhard + email: burger.ga@gmail.com + orcid: https://orcid.org/0000-0003-1062-5576 +references: +- type: software + title: furrr + abstract: 'furrr: Apply Mapping Functions in Parallel using Futures' + notes: Imports + url: https://furrr.futureverse.org/ + repository: https://CRAN.R-project.org/package=furrr + authors: + - family-names: Vaughan + given-names: Davis + email: davis@rstudio.com + - family-names: Dancho + given-names: Matt + email: mdancho@business-science.io + year: '2023' +- 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: '2023' +- type: software + title: tidyr + abstract: 'tidyr: Tidy Messy Data' + notes: Imports + url: https://tidyr.tidyverse.org + repository: https://CRAN.R-project.org/package=tidyr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + - family-names: Vaughan + given-names: Davis + email: davis@posit.co + - family-names: Girlich + given-names: Maximilian + year: '2023' +- type: software + title: stringr + abstract: 'stringr: Simple, Consistent Wrappers for Common String Operations' + notes: Imports + url: https://stringr.tidyverse.org + repository: https://CRAN.R-project.org/package=stringr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2023' +- 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: '2023' +- type: software + title: purrr + abstract: 'purrr: Functional Programming Tools' + notes: Imports + url: https://purrr.tidyverse.org/ + repository: https://CRAN.R-project.org/package=purrr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: Henry + given-names: Lionel + email: lionel@rstudio.com + year: '2023' +- type: software + title: progressr + abstract: 'progressr: An Inclusive, Unifying API for Progress Updates' + notes: Imports + url: https://progressr.futureverse.org + repository: https://CRAN.R-project.org/package=progressr + authors: + - family-names: Bengtsson + given-names: Henrik + email: henrikb@braju.com + year: '2023' +- 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: '2023' +- type: software + title: progress + abstract: 'progress: Terminal Progress Bars' + notes: Suggests + url: https://github.com/r-lib/progress#readme + repository: https://CRAN.R-project.org/package=progress + authors: + - family-names: Csárdi + given-names: Gábor + - family-names: FitzJohn + given-names: Rich + year: '2023' +- 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: '2023' +- type: software + title: tibble + abstract: 'tibble: Simple Data Frames' + notes: Suggests + 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: '2023'