Merge pull request #16 from OxfordIHTM/dev

add codefactor badget; lint palette functions

.github/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ## Bugs
 
-* Submit an issue on the [issues page](https://github.com/OxfordIHTM/icd/issues)
+* Submit an issue on the [issues page](https://github.com/OxfordIHTM/oxfordtheme/issues)
 
 ## Code contributions
 
@@ -11,14 +11,14 @@
 * Clone your version on your account down to your machine from your account
 
 ```
-git clone https://github.com/<yourgithubusername>/icd.git
+git clone https://github.com/<yourgithubusername>/oxfordtheme.git
 ```
 
-* Make sure to track progress upstream i.e., on our version of `icd`
-at `OxfordIHTM/icd`, by doing
+* Make sure to track progress upstream i.e., on our version of `oxfordtheme`
+at `OxfordIHTM/oxfordtheme`, by doing
 
 ```
-git remote add upstream https://github.com/OxfordIHTM/icd.git
+git remote add upstream https://github.com/OxfordIHTM/oxfordtheme.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/icd`
+* Submit a pull request at `OxfordIHTM/oxfordtheme`

DESCRIPTION

@@ -22,4 +22,6 @@ Suggests:
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.2.3
-URL: http://oxford-ihtm.io/oxfordtheme/
+Roxygen: list(markdown = TRUE)
+URL: https://oxford-ihtm.io/oxfordtheme/,https://github.com/OxfordIHTM/oxfordtheme
+BugReports: https://github.com/OxfordIHTM/oxfordtheme/issues

R/create_palette.R

@@ -56,8 +56,11 @@ create_palette_sequential <- function(name, n) {
   ## Update palette to n ----
   pal <- grDevices::colorRampPalette(pal)(n)
 
+  ## Create palette class ----
+  class(pal) <- "palette"
+
   ## Return palette ----
-  structure(pal, class = "palette", name = name)
+  pal
 }
 
 
@@ -91,8 +94,11 @@ create_palette_divergent <- function(name, n) {
   ## Update palette to n ----
   pal <- grDevices::colorRampPalette(pal)(n)
 
+  ## Create palette class ----
+  class(pal) <- "palette"
+
   ## Return palette ----
-  structure(pal, class = "palette", name = name)
+  pal
 }
 
 #'
@@ -134,8 +140,11 @@ create_palette_qualitative <- function(name, n) {
   ## Update palette to n ----
   pal <- grDevices::colorRampPalette(pal)(n)
 
+  ## Create palette class ----
+  class(pal) <- "palette"
+
   ## Return palette ----
-  structure(pal, class = "palette", name = name)
+  pal
 }
 
 

README.Rmd

@@ -22,6 +22,7 @@ library(ggplot2)
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![R-CMD-check](https://github.com/OxfordIHTM/oxfordtheme/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/OxfordIHTM/oxfordtheme/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/OxfordIHTM/oxfordtheme/branch/main/graph/badge.svg)](https://app.codecov.io/gh/OxfordIHTM/oxfordtheme?branch=main)
+[![CodeFactor](https://www.codefactor.io/repository/github/oxfordihtm/oxfordtheme/badge)](https://www.codefactor.io/repository/github/oxfordihtm/oxfordtheme)
 <!-- badges: end -->
 
 Palette, theme, and theme components 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). 
@@ -121,7 +122,7 @@ structure(oxford_theme_palettes()$corporate, class = "palette", name = "corporat
 
 The University of Oxford recommended theme palettes can be used for plotting. Below is code examples of how this can be done both with base R plotting function and with `ggplot2`.
 
-#### Base R plot
+#### Bar plots in base R and using `ggplot`
 
 ```{r mtcars-barplot, fig.show = "hold", fig.height = 8, out.width = "50%"}
 ## Barplot of cyl and vs of mtcars dataset using heritage Oxford theme
@@ -160,6 +161,7 @@ ggplot(
   theme_minimal()
 ```
 
+#### Scatter plots in base R and using `ggplot`
 
 ```{r mtcars-scatterplot, fig.show = "hold", fig.height = 8, out.width = "50%"}
 ## Scatterplot of mpg and disp of mtcars dataset using celebratory Oxford theme
@@ -196,6 +198,9 @@ ggplot(data = mtcars, mapping = aes(x = mpg, y = disp, colour = factor(cyl))) +
   theme_minimal()
 ```
 
+## Author/s
+
+* [Ernest Guevarra](https://github.com/ernestguevarra)
 
 ## Community guidelines
 

README.md

@@ -13,6 +13,7 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
 [![R-CMD-check](https://github.com/OxfordIHTM/oxfordtheme/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/OxfordIHTM/oxfordtheme/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/OxfordIHTM/oxfordtheme/branch/main/graph/badge.svg)](https://app.codecov.io/gh/OxfordIHTM/oxfordtheme?branch=main)
+[![CodeFactor](https://www.codefactor.io/repository/github/oxfordihtm/oxfordtheme/badge)](https://www.codefactor.io/repository/github/oxfordihtm/oxfordtheme)
 <!-- badges: end -->
 
 Palette, theme, and theme components based on [University of
@@ -168,7 +169,7 @@ The University of Oxford recommended theme palettes can be used for
 plotting. Below is code examples of how this can be done both with base
 R plotting function and with `ggplot2`.
 
-#### Base R plot
+#### Bar plots in base R and using `ggplot`
 
 ``` r
 ## Barplot of cyl and vs of mtcars dataset using heritage Oxford theme
@@ -209,6 +210,8 @@ ggplot(
 
 <img src="man/figures/README-mtcars-barplot-1.png" width="50%" /><img src="man/figures/README-mtcars-barplot-2.png" width="50%" />
 
+#### Scatter plots in base R and using `ggplot`
+
 ``` r
 ## Scatterplot of mpg and disp of mtcars dataset using celebratory Oxford theme
 
@@ -246,6 +249,10 @@ ggplot(data = mtcars, mapping = aes(x = mpg, y = disp, colour = factor(cyl))) +
 
 <img src="man/figures/README-mtcars-scatterplot-1.png" width="50%" /><img src="man/figures/README-mtcars-scatterplot-2.png" width="50%" />
 
+## Author/s
+
+- [Ernest Guevarra](https://github.com/ernestguevarra)
+
 ## Community guidelines
 
 Feedback, bug reports and feature requests are welcome; file issues or

inst/CITATION

@@ -0,0 +1,16 @@
+citHeader("To cite oxfordtheme in publications use:")
+
+citEntry(
+  entry    = "Manual",
+  title    = "oxfordtheme: Oxford Palette, Theme, and Theme Components.",
+  author   = person("Ernest Guevarra"),
+  year     = "2024",
+  note     = "R package version 0.0.9000",
+  url      = "https://oxford-ihtm.io/oxfordtheme/",
+  textVersion = paste(
+    paste("Ernest Guevarra (2024).",
+          "oxfordtheme: Oxford Palette, Theme, and Theme Components.",
+          "R package version 0.0.9000.",
+          "URL https://oxford-ihtm.io/oxfordtheme/")
+  )
+)