diff --git a/.Rbuildignore b/.Rbuildignore index 86e4d04..b271ee7 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,4 @@ ^docs$ ^pkgdown$ ^README\.html$ +^CITATION\.cff$ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7e3dfcd..8ab5305 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,23 +2,23 @@ ## Bugs -* Submit an issue on the [issues page](https://github.com/OxfordIHTM/oxfordtheme/issues) +* Submit an issue on the [issues page](https://github.com/OxfordIHTM/oxfordthema/issues) ## Code contributions * Fork this repository to your Github account -* Clone your version on your account down to your machine from your account +* Clone your forked version to your machine -``` -git clone https://github.com//oxfordtheme.git +```bash +git clone https://github.com//oxfordthema.git ``` -* Make sure to track progress upstream i.e., on our version of `oxfordtheme` -at `OxfordIHTM/oxfordtheme`, by doing +* Make sure to track progress upstream i.e., on our version of `oxfordthema` +at `OxfordIHTM/oxfordthema`, by doing -``` -git remote add upstream https://github.com/OxfordIHTM/oxfordtheme.git +```bash +git remote add upstream https://github.com/OxfordIHTM/oxfordthema.git ``` * Before making changes make sure to pull changes in from `upstream` by doing @@ -32,4 +32,4 @@ documentation * Push up changes to your account -* Submit a pull request at `OxfordIHTM/oxfordtheme` +* Submit a pull request at `OxfordIHTM/oxfordthema` diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 14159b7..562fe0f 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -4,9 +4,10 @@ on: push: branches: [main, master] pull_request: - branches: [main, master] -name: R-CMD-check +name: R-CMD-check.yaml + +permissions: read-all jobs: R-CMD-check: diff --git a/.github/workflows/mirror-codeberg.yaml b/.github/workflows/mirror-codeberg.yaml new file mode 100644 index 0000000..97f8817 --- /dev/null +++ b/.github/workflows/mirror-codeberg.yaml @@ -0,0 +1,19 @@ +name: Mirror to other git server +on: + push: + branches: + - main + tags: + - "*" +jobs: + mirror: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - uses: yesolutions/mirror-action@master + with: + REMOTE: https://codeberg.org/OxfordIHTM/oxthema + GIT_USERNAME: ${{ secrets.CODEBERG_USERNAME }} + GIT_PASSWORD: ${{ secrets.CODEBERG_TOKEN }} diff --git a/.github/workflows/netlify.yaml b/.github/workflows/netlify.yaml new file mode 100644 index 0000000..10c6fe1 --- /dev/null +++ b/.github/workflows/netlify.yaml @@ -0,0 +1,53 @@ +on: + pull_request: + branches: [main, master] + +name: pkgdown-pr + +jobs: + netlify: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-tinytex@v2 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Install package + run: R CMD INSTALL . + + - name: Create website + run: | + pkgdown::build_site() + shell: Rscript {0} + + - name: Create index file + run: | + echo ' ' > ./docs/index.html + + - name: Deploy to Netlify + uses: nwtgck/actions-netlify@v3.0 + with: + publish-dir: './docs' + production-branch: main + github-token: ${{ secrets.GITHUB_TOKEN }} + deploy-message: + 'Deploy from GHA: ${{ github.event.pull_request.title || github.event.head_commit.message }} (${{ github.sha }})' + # these default to 'true' + enable-commit-comment: false + enable-github-deployment: false + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index a7276e8..bfc9f4d 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -4,12 +4,13 @@ on: push: branches: [main, master] pull_request: - branches: [main, master] release: types: [published] workflow_dispatch: -name: pkgdown +name: pkgdown.yaml + +permissions: read-all jobs: pkgdown: diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml index 21b8a93..0ab748d 100644 --- a/.github/workflows/test-coverage.yaml +++ b/.github/workflows/test-coverage.yaml @@ -4,9 +4,10 @@ on: push: branches: [main, master] pull_request: - branches: [main, master] -name: test-coverage +name: test-coverage.yaml + +permissions: read-all jobs: test-coverage: @@ -23,18 +24,29 @@ jobs: - uses: r-lib/actions/setup-r-dependencies@v2 with: - extra-packages: any::covr + extra-packages: any::covr, any::xml2 needs: coverage - name: Test coverage run: | - covr::codecov( + cov <- covr::package_coverage( quiet = FALSE, clean = FALSE, install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package") ) + print(cov) + covr::to_cobertura(cov) shell: Rscript {0} + - uses: codecov/codecov-action@v5 + with: + # Fail if error if not on PR, or if on PR and token is given + fail_ci_if_error: ${{ github.event_name != 'pull_request' || secrets.CODECOV_TOKEN }} + files: ./cobertura.xml + plugins: noop + disable_search: true + token: ${{ secrets.CODECOV_TOKEN }} + - name: Show testthat output if: always() run: | diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..fafb735 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,317 @@ +# -------------------------------------------- +# CITATION file created with {cffr} R package +# See also: https://docs.ropensci.org/cffr/ +# -------------------------------------------- + +cff-version: 1.2.0 +message: 'To cite package "oxthema" in publications use:' +type: software +license: GPL-3.0-or-later +title: 'oxthema: Oxford Colours, Palettes, Fonts, and Themes' +version: 0.1.0 +doi: 10.5281/zenodo.10721129 +abstract: Colours, palettes, fonts, and themes based on University of Oxford's visual + identity guidelines . +authors: +- family-names: Guevarra + given-names: Ernest + email: ernest@guevarra.io + orcid: https://orcid.org/0000-0002-4887-4415 +- family-names: Malijan + given-names: Greco +preferred-citation: + type: manual + title: 'oxthema: Oxford Palette, Theme, and Theme Components.' + authors: + - name: Ernest Guevarra + - name: Greco Malijan + year: '2026' + notes: R package version 0.1.0 + url: https://oxford-ihtm.io/oxthema/ + doi: 10.5281/zenodo.10721129 +repository-code: https://github.com/OxfordIHTM/oxthema +url: https://oxford-ihtm.io/oxthema/ +contact: +- family-names: Guevarra + given-names: Ernest + email: ernest@guevarra.io + orcid: https://orcid.org/0000-0002-4887-4415 +keywords: +- ggplot-themes +- oxford +- r +- rstats +references: +- 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: '2026' + version: '>= 4.1.0' +- type: software + title: forestploter + abstract: 'forestploter: Create a Flexible Forest Plot' + notes: Imports + url: https://github.com/adayim/forestploter + repository: https://CRAN.R-project.org/package=forestploter + authors: + - family-names: Dayimu + given-names: Alimu + email: ad938@cam.ac.uk + orcid: https://orcid.org/0000-0001-9998-7463 + year: '2026' + doi: 10.32614/CRAN.package.forestploter +- 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: '2026' + doi: 10.32614/CRAN.package.ggplot2 +- 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: '2026' + doi: 10.32614/CRAN.package.stringr +- type: software + title: systemfonts + abstract: 'systemfonts: System Native Font Finding' + notes: Imports + url: https://systemfonts.r-lib.org + repository: https://CRAN.R-project.org/package=systemfonts + authors: + - family-names: Pedersen + given-names: Thomas Lin + email: thomas.pedersen@posit.co + orcid: https://orcid.org/0000-0002-5147-4711 + - family-names: Ooms + given-names: Jeroen + email: jeroen@berkeley.edu + orcid: https://orcid.org/0000-0002-4035-0289 + - family-names: Govett + given-names: Devon + year: '2026' + doi: 10.32614/CRAN.package.systemfonts +- type: software + title: withr + abstract: 'withr: Run Code ''With'' Temporarily Modified Global State' + notes: Imports + url: https://withr.r-lib.org + repository: https://CRAN.R-project.org/package=withr + authors: + - family-names: Hester + given-names: Jim + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + - family-names: Müller + given-names: Kirill + email: krlmlr+r@mailbox.org + - family-names: Ushey + given-names: Kevin + email: kevinushey@gmail.com + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + - family-names: Chang + given-names: Winston + year: '2026' + doi: 10.32614/CRAN.package.withr +- type: software + title: covr + abstract: 'covr: Test Coverage for Packages' + notes: Suggests + url: https://covr.r-lib.org + repository: https://CRAN.R-project.org/package=covr + authors: + - family-names: Hester + given-names: Jim + email: james.f.hester@gmail.com + year: '2026' + doi: 10.32614/CRAN.package.covr +- 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: '2026' + doi: 10.32614/CRAN.package.knitr +- type: software + title: ragg + abstract: 'ragg: Graphic Devices Based on AGG' + notes: Suggests + url: https://ragg.r-lib.org + repository: https://CRAN.R-project.org/package=ragg + authors: + - family-names: Pedersen + given-names: Thomas Lin + email: thomas.pedersen@posit.co + orcid: https://orcid.org/0000-0002-5147-4711 + - family-names: Shemanarev + given-names: Maxim + year: '2026' + doi: 10.32614/CRAN.package.ragg +- 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: '2026' + doi: 10.32614/CRAN.package.rmarkdown +- type: software + title: sf + abstract: 'sf: Simple Features for R' + notes: Suggests + url: https://r-spatial.github.io/sf/ + repository: https://CRAN.R-project.org/package=sf + authors: + - family-names: Pebesma + given-names: Edzer + email: edzer.pebesma@uni-muenster.de + orcid: https://orcid.org/0000-0001-8049-7069 + year: '2026' + doi: 10.32614/CRAN.package.sf +- type: software + title: showtext + abstract: 'showtext: Using Fonts More Easily in R Graphs' + notes: Suggests + url: https://github.com/yixuan/showtext + repository: https://CRAN.R-project.org/package=showtext + authors: + - family-names: Qiu + given-names: Yixuan + - family-names: details. + given-names: authors/contributors of the included software. See file AUTHORS for + year: '2026' + doi: 10.32614/CRAN.package.showtext +- type: software + title: spelling + abstract: 'spelling: Tools for Spell Checking in R' + notes: Suggests + url: https://ropensci.r-universe.dev/spelling + repository: https://CRAN.R-project.org/package=spelling + authors: + - family-names: Ooms + given-names: Jeroen + email: jeroenooms@gmail.com + orcid: https://orcid.org/0000-0002-4035-0289 + - family-names: Hester + given-names: Jim + email: james.hester@rstudio.com + year: '2026' + doi: 10.32614/CRAN.package.spelling +- type: software + title: sysfonts + abstract: 'sysfonts: Loading Fonts into R' + notes: Suggests + url: https://github.com/yixuan/sysfonts + repository: https://CRAN.R-project.org/package=sysfonts + authors: + - family-names: Qiu + given-names: Yixuan + - family-names: details. + given-names: authors/contributors of the included fonts. See file AUTHORS for + year: '2026' + doi: 10.32614/CRAN.package.sysfonts +- 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: '2026' + doi: 10.32614/CRAN.package.testthat + version: '>= 3.0.0' + diff --git a/DESCRIPTION b/DESCRIPTION index 5e3eb6b..85cf35d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: oxthema Type: Package Title: Oxford Colours, Palettes, Fonts, and Themes -Version: 0.0.0.9000 +Version: 0.1.0 Authors@R: c( person(given = "Ernest", family = "Guevarra", comment = c(ORCID = "0000-0002-4887-4415"), @@ -12,7 +12,7 @@ Description: Colours, palettes, fonts, and themes based on University of . License: GPL (>= 3) Depends: - R (>= 2.10) + R (>= 4.1.0) Imports: forestploter, ggplot2, @@ -32,7 +32,7 @@ Suggests: Encoding: UTF-8 Language: en-GB LazyData: true -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.3 Roxygen: list(markdown = TRUE) URL: https://oxford-ihtm.io/oxthema/,https://github.com/OxfordIHTM/oxthema BugReports: https://github.com/OxfordIHTM/oxthema/issues diff --git a/README.Rmd b/README.Rmd index 6001a4c..67cb6a3 100644 --- a/README.Rmd +++ b/README.Rmd @@ -19,7 +19,7 @@ knitr::opts_chunk$set( [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![R-CMD-check](https://github.com/OxfordIHTM/oxthema/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/OxfordIHTM/oxthema/actions/workflows/R-CMD-check.yaml) [![test-coverage](https://github.com/OxfordIHTM/oxthema/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/OxfordIHTM/oxthema/actions/workflows/test-coverage.yaml) -[![Codecov test coverage](https://codecov.io/gh/OxfordIHTM/oxthema/branch/main/graph/badge.svg)](https://app.codecov.io/gh/OxfordIHTM/oxthema?branch=main) +[![Codecov test coverage](https://codecov.io/gh/OxfordIHTM/oxthema/graph/badge.svg)](https://app.codecov.io/gh/OxfordIHTM/oxthema) [![CodeFactor](https://www.codefactor.io/repository/github/oxfordihtm/oxthema/badge)](https://www.codefactor.io/repository/github/oxfordihtm/oxthema) [![DOI](https://zenodo.org/badge/711630340.svg)](https://zenodo.org/doi/10.5281/zenodo.10721129) @@ -27,20 +27,20 @@ knitr::opts_chunk$set( Colours, palettes, fonts, and themes based on [University of Oxford](https://ox.ac.uk)'s [visual identity guidelines](https://communications.web.ox.ac.uk/communications-resources/visual-identity/identity-guidelines). -## What does `oxthema` do? +## What does the package do? -`oxthema` aims to provide templates, themes, and theme components for colour palettes, typography, and layout compliant with [University of Oxford](https://ox.ac.uk)'s [visual identity guidelines](https://communications.web.ox.ac.uk/communications-resources/visual-identity/identity-guidelines) for use in the R language for statistical computing graphics and publishing ecosystem. +`{oxthema}` aims to provide templates, themes, and theme components for colour palettes, typography, and layout compliant with [University of Oxford](https://ox.ac.uk)'s [visual identity guidelines](https://communications.web.ox.ac.uk/communications-resources/visual-identity/identity-guidelines) for use in the R language for statistical computing graphics and publishing ecosystem. The package provides colours, palettes, and fonts consistent with the university visual identity guidelines. The package also includes themes for specific packages and functionalities that make use of colours, palettes, and fonts. The package currently has themes for `{ggplot2}` and for `{forestploter}` packages. To see a list of features that we are either actively working on, are considering, or need help on, visit our [GitHub issues](https://github.com/OxfordIHTM/oxthema/issues) page. -`oxthema` is currently in pre-release (alpha release) to allow for alpha testing of current functionalities. +`{oxthema}` is currently in pre-release (alpha release) to allow for alpha testing of current functionalities. ## Installation -`oxthema` is not yet available on [CRAN](https://cran.r-project.org) but can be installed through the [Oxford iHealth R Universe](https://oxfordihtm.r-universe.dev) repository as follows: +`{oxthema}` is not yet available on [CRAN](https://cran.r-project.org) but can be installed through the [Oxford iHealth R Universe](https://oxfordihtm.r-universe.dev) repository as follows: ```R install.packages( @@ -51,7 +51,7 @@ install.packages( ## Usage -The following vignettes provide details on how to make full use of the `oxthema` package: +The following vignettes provide details on how to make full use of the `{oxthema}` package: * [Oxford colours](https://oxford-ihtm.io/oxthema/articles/oxford-colours.html) @@ -63,6 +63,14 @@ The following vignettes provide details on how to make full use of the `oxthema` * [Oxford forestploter themes](https://oxford-ihtm.io/oxthema/articles/oxford-forestploter-themes.html) +## Citation + +If you use the `{oxthema}` in your work, please cite using the suggested citation provided by a call to the `citation` function as follows: + +```{r citation, echo = TRUE, eval = TRUE} +citation("oxthema") +``` + ## Community guidelines Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/OxfordIHTM/oxthema/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://oxford-ihtm.io/oxthema/CONTRIBUTING.html). diff --git a/README.md b/README.md index 9da3756..30b997f 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https:// [![R-CMD-check](https://github.com/OxfordIHTM/oxthema/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/OxfordIHTM/oxthema/actions/workflows/R-CMD-check.yaml) [![test-coverage](https://github.com/OxfordIHTM/oxthema/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/OxfordIHTM/oxthema/actions/workflows/test-coverage.yaml) [![Codecov test -coverage](https://codecov.io/gh/OxfordIHTM/oxthema/branch/main/graph/badge.svg)](https://app.codecov.io/gh/OxfordIHTM/oxthema?branch=main) +coverage](https://codecov.io/gh/OxfordIHTM/oxthema/graph/badge.svg)](https://app.codecov.io/gh/OxfordIHTM/oxthema) [![CodeFactor](https://www.codefactor.io/repository/github/oxfordihtm/oxthema/badge)](https://www.codefactor.io/repository/github/oxfordihtm/oxthema) [![DOI](https://zenodo.org/badge/711630340.svg)](https://zenodo.org/doi/10.5281/zenodo.10721129) @@ -22,9 +22,9 @@ Colours, palettes, fonts, and themes based on [University of Oxford](https://ox.ac.uk)’s [visual identity guidelines](https://communications.web.ox.ac.uk/communications-resources/visual-identity/identity-guidelines). -## What does `oxthema` do? +## What does the package do? -`oxthema` aims to provide templates, themes, and theme components for +`{oxthema}` aims to provide templates, themes, and theme components for colour palettes, typography, and layout compliant with [University of Oxford](https://ox.ac.uk)’s [visual identity guidelines](https://communications.web.ox.ac.uk/communications-resources/visual-identity/identity-guidelines) @@ -41,13 +41,13 @@ To see a list of features that we are either actively working on, are considering, or need help on, visit our [GitHub issues](https://github.com/OxfordIHTM/oxthema/issues) page. -`oxthema` is currently in pre-release (alpha release) to allow for alpha -testing of current functionalities. +`{oxthema}` is currently in pre-release (alpha release) to allow for +alpha testing of current functionalities. ## Installation -`oxthema` is not yet available on [CRAN](https://cran.r-project.org) but -can be installed through the [Oxford iHealth R +`{oxthema}` is not yet available on [CRAN](https://cran.r-project.org) +but can be installed through the [Oxford iHealth R Universe](https://oxfordihtm.r-universe.dev) repository as follows: ``` r @@ -60,22 +60,48 @@ install.packages( ## Usage The following vignettes provide details on how to make full use of the -`oxthema` package: +`{oxthema}` package: - - [Oxford - colours](https://oxford-ihtm.io/oxthema/articles/oxford-colours.html) +- [Oxford + colours](https://oxford-ihtm.io/oxthema/articles/oxford-colours.html) - - [Oxford - palettes](https://oxford-ihtm.io/oxthema/articles/oxford-palettes.html) +- [Oxford + palettes](https://oxford-ihtm.io/oxthema/articles/oxford-palettes.html) - - [Oxford - fonts](https://oxford-ihtm.io/oxthema/articles/oxford-fonts.html) +- [Oxford + fonts](https://oxford-ihtm.io/oxthema/articles/oxford-fonts.html) - - [Oxford ggplot2 - themes](https://oxford-ihtm.io/oxthema/articles/oxford-ggplot2-themes.html) +- [Oxford ggplot2 + themes](https://oxford-ihtm.io/oxthema/articles/oxford-ggplot2-themes.html) - - [Oxford forestploter - themes](https://oxford-ihtm.io/oxthema/articles/oxford-forestploter-themes.html) +- [Oxford forestploter + themes](https://oxford-ihtm.io/oxthema/articles/oxford-forestploter-themes.html) + +## Citation + +If you use the `{oxthema}` in your work, please cite using the suggested +citation provided by a call to the `citation` function as follows: + +``` r +citation("oxthema") +#> To cite oxthema in publications use: +#> +#> Ernest Guevarra, Greco Malijan (2026). _oxthema: Oxford Palette, +#> Theme, and Theme Components._. doi:10.5281/zenodo.10721129 +#> , R package version 0.1.0, +#> . +#> +#> A BibTeX entry for LaTeX users is +#> +#> @Manual{, +#> title = {oxthema: Oxford Palette, Theme, and Theme Components.}, +#> author = {{Ernest Guevarra} and {Greco Malijan}}, +#> year = {2026}, +#> note = {R package version 0.1.0}, +#> url = {https://oxford-ihtm.io/oxthema/}, +#> doi = {https://doi.org/10.5281/zenodo.10721129}, +#> } +``` ## Community guidelines diff --git a/inst/CITATION b/inst/CITATION index 5ff7a99..ab4040d 100644 --- a/inst/CITATION +++ b/inst/CITATION @@ -1,10 +1,10 @@ bibentry( bibtype = "Manual", - header = "To cite oxfordtheme in publications use:", + header = "To cite oxthema in publications use:", title = "oxthema: Oxford Palette, Theme, and Theme Components.", author = c(person("Ernest Guevarra"), person("Greco Malijan")), - year = "2024", - note = "R package version 0.0.9000", - url = "https://oxford-ihtm.io/oxfordtheme/", - doi = "https://zenodo.org/doi/10.5281/zenodo.10721129" + year = "2026", + note = "R package version 0.1.0", + url = "https://oxford-ihtm.io/oxthema/", + doi = "https://doi.org/10.5281/zenodo.10721129" ) diff --git a/inst/WORDLIST b/inst/WORDLIST index c5eec03..7ad79f6 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -4,7 +4,6 @@ CMD CodeFactor Codecov ColorBrewer -IHTM Lifecycle MUAC Neue @@ -15,7 +14,6 @@ RColorBrewer RStudio Roboto Rudis -WIP ac bl cmyk @@ -26,6 +24,7 @@ forestploter gam ggplot hrbrthemes +iHealth localityID mam muac diff --git a/man/oxford_theme.Rd b/man/oxford_theme.Rd index a4629da..80d2b8e 100644 --- a/man/oxford_theme.Rd +++ b/man/oxford_theme.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/oxford_theme_ggplot2.R \name{theme_oxford} \alias{theme_oxford} -\title{A generic/base \link{ggplot2} theme for the oxthema package} +\title{A generic/base \link[ggplot2:ggplot2-package]{ggplot2::ggplot2} theme for the oxthema package} \usage{ theme_oxford( base_family = "Roboto", @@ -145,10 +145,10 @@ NULL.} \item{ticks}{Logical. Should ticks be added? Default is FALSE.} } \value{ -A \link{ggplot2} theme. +A \link[ggplot2:ggplot2-package]{ggplot2::ggplot2} theme. } \description{ -This generic/base \link{ggplot2} theme is the template from which all other +This generic/base \link[ggplot2:ggplot2-package]{ggplot2::ggplot2} theme is the template from which all other themes in the \link{oxthema} package is built on. This theme is inspired by Bob Rudis' \href{https://github.com/hrbrmstr/hrbrthemes}{hrbrthemes} package drawing heavily on its typography-centric focus. This function uses the diff --git a/man/theme_forest.Rd b/man/theme_forest.Rd index 4e77a8c..e28eb6a 100644 --- a/man/theme_forest.Rd +++ b/man/theme_forest.Rd @@ -7,7 +7,7 @@ \alias{theme_celebratory_forest} \alias{theme_corporate_forest} \alias{theme_innovative_forest} -\title{Oxford theme for \link{forestploter} package} +\title{Oxford theme for \link[forestploter:forestploter-package]{forestploter::forestploter} package} \usage{ theme_oxford_forest( base_size = 11.5, @@ -172,7 +172,7 @@ to value of \code{summary_col}.} A list of specified theme parameters. } \description{ -Oxford theme for \link{forestploter} package +Oxford theme for \link[forestploter:forestploter-package]{forestploter::forestploter} package } \examples{ theme_oxford_forest() diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml index 6db5a29..73a7139 100644 --- a/pkgdown/_pkgdown.yml +++ b/pkgdown/_pkgdown.yml @@ -9,7 +9,17 @@ template: bootstrap: 5 bootswatch: sandstone theme: breeze-light - ganalytics: G-Q6WH77FEH4 + includes: + in_header: | + + + home: links: @@ -21,7 +31,7 @@ navbar: type: light structure: left: [home, intro, reference, articles, news] - right: [search, linkedin, mastodon, github] + right: [search, website, mastodon, bluesky, linkedin, github] components: articles: @@ -37,13 +47,22 @@ navbar: href: articles/oxford-ggplot2-themes.html - text: "Oxford forestploter Themes" href: articles/oxford-forestploter-themes.html - linkedin: - icon: "fab fa-linkedin fa-lg" - href: https://www.linkedin.com/company/oxford-ihealth + website: + icon: "fa-globe" + href: https://oxford-ihtm.io + aria-label: Website mastodon: icon: "fab fa-mastodon fa-lg" href: https://mastodon.social/@ihealth - + aria-label: Mastodon + bluesky: + icon: "fab fa-bluesky fa-lg" + href: https://bsky.app/profile/oxford-ihealth.org + aria-label: Bluesky + linkedin: + icon: "fab fa-linkedin fa-lg" + href: https://www.linkedin.com/company/oxford-ihealth + aria-label: LinkedIn reference: - title: Description