tweak default colours for hl_grep and hl_diff()

NAMESPACE

@@ -16,6 +16,7 @@ export(hl_grep)
 export(hl_opts)
 export(is_emphatic)
 export(knit_print.emphatic)
+export(show_html)
 export(write_xlsx)
 importFrom(grDevices,col2rgb)
 importFrom(grDevices,convertColor)

R/core-html.R

@@ -157,6 +157,7 @@ as_html <- function(x, ..., style = NULL, complete = FALSE, browsable = FALSE) {
 #' @param viewer function which activates viewer
 #' @return None
 #' @export
+#' @examples
 #' # Will try and spawn a viewer for content
 #' hl_grep(mode, "switch") |>
 #'   as_html() |>

R/zzz.R

@@ -67,13 +67,13 @@ get_env_dbl <- function(nm, unset) {
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .onLoad <- function(libname, pkgname) {
 
-  options(HL_NA            = Sys.getenv ("HL_NA"           , unset =          'NA'))
-  options(HL_TEXT_MODE     = Sys.getenv ("HL_TEXT_MODE"    , unset =    'contrast'))
-  options(HL_TEXT_CONTRAST = get_env_dbl("HL_TEXT_CONTRAST", unset =             1))
-  options(HL_GREP_COL      = Sys.getenv("HL_GREP_COL"      , unset =     "#0F19F0"))
-  options(HL_SUB_COL       = Sys.getenv("HL_SUB_COL"       , unset =  "dodgerblue"))
-  options(HL_INS_COL       = Sys.getenv("HL_INS_COL"       , unset =   "darkgreen"))
-  options(HL_DEL_COL       = Sys.getenv("HL_DEL_COL"       , unset =   "firebrick"))
+  options(HL_NA            = Sys.getenv ("HL_NA"           , unset =             'NA'))
+  options(HL_TEXT_MODE     = Sys.getenv ("HL_TEXT_MODE"    , unset =       'contrast'))
+  options(HL_TEXT_CONTRAST = get_env_dbl("HL_TEXT_CONTRAST", unset =                1))
+  options(HL_GREP_COL      = Sys.getenv("HL_GREP_COL"      , unset =         "yellow"))
+  options(HL_SUB_COL       = Sys.getenv("HL_SUB_COL"       , unset = "darkslategray1"))
+  options(HL_INS_COL       = Sys.getenv("HL_INS_COL"       , unset =     "palegreen1"))
+  options(HL_DEL_COL       = Sys.getenv("HL_DEL_COL"       , unset =     "rosybrown1"))
 
   # Is this the Rstudio 256 colour console?
   rstudio_256 <- Sys.getenv("RSTUDIO_CONSOLE_COLOR", 0) == 256

README.Rmd

@@ -328,7 +328,7 @@ writeLines(svg, "data-raw/figures/example-svg-anim.svg")
 |  | `"remove"` remove all text without a user-defined colour  |
 | `HL_TEXT_CONTRAST` | When `text_mode = "contrast"` this numeric value (in range [0, 1]) adjusts the visibility of the text. Default: 1 (high contrast)  |
 | `HL_GREP_COL`      |The fill colour to use with `hl_grep()` if no colour is specified. Default: "#0F19F0"|
-| `HL_SUB_COL`, `HL_INS_COL`, `HL_DEL_COL`     |  the default colours to use with `hl_diff()` for substitution, insertion and deletion (respectively). Defaults: `dodgerblue` (substitute), `darkgreen` (insert) and `firebrick` (delete)  |
+| `HL_SUB_COL`, `HL_INS_COL`, `HL_DEL_COL`     |  the default colours to use with `hl_diff()` for substitution, insertion and deletion (respectively).  |
 
 
 ## Vignettes

README.md

@@ -190,17 +190,17 @@ svg <- as_svg_anim(objs, width = 600, height = 300, duration = 2,
     `.Rprofile`
   - `options(HL_NA = FALSE)` at any time
 
-| Option                                   | Description                                                                                                                                                                             |
-|:-----------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `HL_NA`                                  | String to use for NA values. Default “NA”                                                                                                                                               |
-| `HL_FULL_COLOUR`                         | Should full colour ANSI codes be used when outputting to the console? Default: FALSE on Rstudio, but TRUE on all other R consoles                                                       |
-| `HL_TEXT_MODE`                           | How to handle text if no text colour has been explicitly specified by the user                                                                                                          |
-|                                          | `"contrast"` (default) automatically select a colour which contrasts with the background                                                                                                |
-|                                          | `"asis"` do not change the colour from the console’s default                                                                                                                            |
-|                                          | `"remove"` remove all text without a user-defined colour                                                                                                                                |
-| `HL_TEXT_CONTRAST`                       | When `text_mode = "contrast"` this numeric value (in range \[0, 1\]) adjusts the visibility of the text. Default: 1 (high contrast)                                                     |
-| `HL_GREP_COL`                            | The fill colour to use with `hl_grep()` if no colour is specified. Default: “\#0F19F0”                                                                                                  |
-| `HL_SUB_COL`, `HL_INS_COL`, `HL_DEL_COL` | the default colours to use with `hl_diff()` for substitution, insertion and deletion (respectively). Defaults: `dodgerblue` (substitute), `darkgreen` (insert) and `firebrick` (delete) |
+| Option                                   | Description                                                                                                                         |
+|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------|
+| `HL_NA`                                  | String to use for NA values. Default “NA”                                                                                           |
+| `HL_FULL_COLOUR`                         | Should full colour ANSI codes be used when outputting to the console? Default: FALSE on Rstudio, but TRUE on all other R consoles   |
+| `HL_TEXT_MODE`                           | How to handle text if no text colour has been explicitly specified by the user                                                      |
+|                                          | `"contrast"` (default) automatically select a colour which contrasts with the background                                            |
+|                                          | `"asis"` do not change the colour from the console’s default                                                                        |
+|                                          | `"remove"` remove all text without a user-defined colour                                                                            |
+| `HL_TEXT_CONTRAST`                       | When `text_mode = "contrast"` this numeric value (in range \[0, 1\]) adjusts the visibility of the text. Default: 1 (high contrast) |
+| `HL_GREP_COL`                            | The fill colour to use with `hl_grep()` if no colour is specified. Default: “\#0F19F0”                                              |
+| `HL_SUB_COL`, `HL_INS_COL`, `HL_DEL_COL` | the default colours to use with `hl_diff()` for substitution, insertion and deletion (respectively).                                |
 
 ## Vignettes