Skip to content

Commit

Permalink
Add CITATION.cff
Browse files Browse the repository at this point in the history
  • Loading branch information
burgerga committed Dec 13, 2023
1 parent d0e15b0 commit 580a1b7
Show file tree
Hide file tree
Showing 3 changed files with 247 additions and 0 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
^README\.Rmd$
^LICENSE\.md$
^\.github$
^CITATION\.cff$
58 changes: 58 additions & 0 deletions .github/workflows/update-citation-cff.yaml
Original file line number Diff line number Diff line change
@@ -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"
188 changes: 188 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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: [email protected]
orcid: https://orcid.org/0000-0003-1062-5576
- family-names: Heldring
given-names: Muriel
email: [email protected]
orcid: https://orcid.org/0000-0002-3565-7227
- family-names: Wink
given-names: Steven
email: [email protected]
orcid: https://orcid.org/0000-0003-1189-7231
contact:
- family-names: Burger
given-names: Gerhard
email: [email protected]
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: [email protected]
- family-names: Dancho
given-names: Matt
email: [email protected]
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: [email protected]
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: [email protected]
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: [email protected]
- family-names: Vaughan
given-names: Davis
email: [email protected]
- 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: [email protected]
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: [email protected]
- family-names: Wickham
given-names: Hadley
email: [email protected]
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: [email protected]
orcid: https://orcid.org/0000-0003-4757-117X
- family-names: Henry
given-names: Lionel
email: [email protected]
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: [email protected]
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: [email protected]
- family-names: Wickham
given-names: Hadley
email: [email protected]
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: [email protected]
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: [email protected]
orcid: https://orcid.org/0000-0002-1416-3412
- family-names: Wickham
given-names: Hadley
email: [email protected]
year: '2023'

0 comments on commit 580a1b7

Please sign in to comment.