diff --git a/.Rbuildignore b/.Rbuildignore index 2288264..d2a4c93 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -24,3 +24,4 @@ benchmarks\.Rmd .*\.tar\.gz \.github ^pkgdown$ +^CITATION\.cff$ diff --git a/.github/workflows/validate-citation-cff.yml b/.github/workflows/validate-citation-cff.yml new file mode 100644 index 0000000..59f6976 --- /dev/null +++ b/.github/workflows/validate-citation-cff.yml @@ -0,0 +1,24 @@ +name: Validate CITATION.cff + +on: + pull_request: + paths: + - CITATION.cff + - .github/workflows/validate-citation-cff.yml + push: + paths: + - CITATION.cff + - .github/workflows/validate-citation-cff.yml + workflow_dispatch: + +permissions: + contents: read + +jobs: + validate: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + - uses: citation-file-format/cffconvert-github-action@4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 # 2.0.0 + with: + args: "--validate" diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..5e6af3b --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,63 @@ +cff-version: 1.2.0 +message: 'To cite package "fmcmc" in publications use:' +type: software +license: MIT +title: 'fmcmc: A friendly MCMC framework' +version: 0.6-0 +doi: 10.32614/CRAN.package.fmcmc +abstract: 'Provides a friendly (flexible) Markov Chain Monte Carlo (MCMC) framework + for implementing Metropolis-Hastings algorithm in a modular way allowing users to + specify automatic convergence checker, personalized transition kernels, and out-of-the-box + multiple MCMC chains using parallel computing. Most of the methods implemented in + this package can be found in Brooks et al. (2011, ISBN 9781420079425). Among the + methods included, we have: Haario (2001) + Adaptive Metropolis, Vihola (2012) Robust + Adaptive Metropolis, and Thawornwattana et al. (2018) + Mirror transition kernels.' +authors: +- family-names: Vega Yon + given-names: George + email: g.vegayon@gmail.com + orcid: https://orcid.org/0000-0002-3171-0844 +preferred-citation: + type: article + title: 'fmcmc: A friendly MCMC framework' + authors: + - family-names: Vega Yon + given-names: George + orcid: https://orcid.org/0000-0002-3171-0844 + email: g.vegayon@gmail.com + - family-names: Marjoram + given-names: Paul + orcid: https://orcid.org/0000-0003-0824-7449 + journal: Journal of Open Source Software + year: '2019' + month: '7' + volume: '4' + issue: '39' + doi: 10.21105/joss.01427 + url: https://doi.org/10.21105/joss.01427 + start: '1427' +repository: https://CRAN.R-project.org/package=fmcmc +repository-code: https://github.com/USCbiostats/fmcmc +url: https://uscbiostats.github.io/fmcmc/ +date-released: '2025-12-03' +contact: +- family-names: Vega Yon + given-names: George + email: g.vegayon@gmail.com + orcid: https://orcid.org/0000-0002-3171-0844 +references: +- type: manual + title: 'fmcmc: A friendly MCMC framework' + authors: + - family-names: Vega Yon + given-names: George + orcid: https://orcid.org/0000-0002-3171-0844 + - family-names: Marjoram + given-names: Paul + orcid: https://orcid.org/0000-0003-0824-7449 + year: '2025' + notes: R package version 0.6-0 + url: https://github.com/USCbiostats/fmcmc + doi: 10.32614/CRAN.package.fmcmc