docs

Author: dcooley

DESCRIPTION

@@ -26,6 +26,7 @@ Imports:
     graphics,
     Rcpp (>= 1.0.10)
 RoxygenNote: 7.2.3
+Roxygen: list(markdown = TRUE)
 Suggests: 
     covr,
     microbenchmark,

R/colour_values_hex.R

@@ -25,10 +25,8 @@
 #' @details
 #'
 #' The palette can either be
-#' \itemize{
-#'   \item{String - }{use \code{colour_palettes()} to view available palettes}
-#'   \item{Matrix - }{At least 5 rows, and 3 (or 4) columns representing the red, green and blue (and alpha) values}
-#' }
+#'  * String - use \code{colour_palettes()} to view available palettes
+#'  * Matrix - At least 5 rows, and 3 (or 4) columns representing the red, green and blue (and alpha) values
 #'
 #' The matrix \code{palette} requires 5 rows because the colours are interpolated using a
 #' cubic b-spline. This method requires 5 values.

R/colour_values_rgb.R

@@ -9,10 +9,8 @@
 #' @details
 #'
 #' The palette can either be
-#' \itemize{
-#'   \item{String - }{use \code{colour_palettes()} to view available palettes}
-#'   \item{Matrix - }{At least 5 rows, and 3 (or 4) columns representing the red, green and blue (and alpha) values}
-#' }
+#'  * String - use \code{colour_palettes()} to view available palettes
+#'  * Matrix - At least 5 rows, and 3 (or 4) columns representing the red, green and blue (and alpha) values
 #'
 #' The matrix \code{palette} requires 5 rows because the colours are interpolated using a
 #' cubic b-spline. This method requires 5 values.

R/palettes.R

@@ -36,16 +36,14 @@ get_palette <- function( palette, rgb = TRUE ) {
 #' "viridis","rcolorbrewer","grdevices","colorspace","colorramp". NULL will reutrn all palettes.
 #'
 #' @details
-#' The palettes avaialble in \code{colourvalues} have been derived from those avaialble in
+#' The palettes available in \code{colourvalues} have been derived from those in
 #' the libraries
 #'
-#' \itemize{
-#'   \item{viridis}
-#'   \item{RColorBrewer}
-#'   \item{grDevices}
-#'   \item{colorspaces}
-#'   \item{colorRamp}
-#' }
+#'  * viridis
+#'  * RColorBrewer
+#'  * grDevices
+#'  * colorspaces
+#'  * colorRamp
 #'
 #' @examples
 #' colour_palettes()