shindig

More getting rid of with_flair

.gitignore

@@ -4,3 +4,5 @@ old_R
 dev
 doc
 Meta
+.Rhistory
+joss

DESCRIPTION

@@ -35,4 +35,4 @@ VignetteBuilder:
     knitr
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.1.0
+RoxygenNote: 7.1.1

NAMESPACE

@@ -1,18 +1,19 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(flair_all,decorated)
 S3method(flair_all,default)
-S3method(flair_all,with_flair)
+S3method(flair_lines,decorated)
 S3method(flair_lines,default)
-S3method(flair_lines,with_flair)
+S3method(flair_rx,decorated)
 S3method(flair_rx,default)
-S3method(flair_rx,with_flair)
+S3method(mask_rx,decorated)
 S3method(mask_rx,default)
-S3method(mask_rx,with_flair)
-S3method(print,with_flair)
+S3method(print,decorated)
 export("%>%")
 export(decorate)
 export(decorate_chunk)
 export(decorate_code)
+export(decorated)
 export(flair)
 export(flair_all)
 export(flair_args)
@@ -21,7 +22,7 @@ export(flair_input_vals)
 export(flair_lines)
 export(flair_quick)
 export(flair_rx)
-export(knit_print.with_flair)
+export(knit_print.decorated)
 export(mask)
 export(mask_quick)
 export(mask_rx)
@@ -38,7 +39,6 @@ export(txt_style)
 export(txt_tag)
 export(txt_tocode)
 export(txt_ul)
-export(with_flair)
 export(wrap_html)
 import(stringr)
 importFrom(glue,glue)

R/decorate.R

@@ -1,5 +1,5 @@
 
-#' Builds a \code{\link{with_flair}} object from either a code chunk or a
+#' Builds a \code{\link{decorated}} object from either a code chunk or a
 #' string object containing source code.
 #'
 #' \code{decorate} does its best to guess if it has been given a code string or
@@ -8,7 +8,7 @@
 #' @param x A string, containing either a chunk label or R code.
 #' @param ... Chunk options to pass along
 #'
-#' @return A \code{with_flair} object.
+#' @return A \code{decorated} object.
 #'
 #' @seealso \code{\link{decorate_chunk}}, \code{\link{decorate_code}}
 #'

R/flair.R

@@ -4,12 +4,12 @@
 #'
 #' If input is a string object, \code{flair} returns a formatted string.
 #'
-#' If input is a \code{\link{with_flair}} object, \code{flair} returns a
-#'  \code{\link{with_flair}} object with the source elements formatted.
+#' If input is a \code{\link{decorated}} object, \code{flair} returns a
+#'  \code{\link{decorated}} object with the source elements formatted.
 #'
 #' Currently, \code{flair} is only built for html formatting.
 #'
-#' @param x A string or \code{\link{with_flair}} object
+#' @param x A string or \code{\link{decorated}} object
 #' @param pattern A pattern to match.  By default, this is a fixed pattern;
 #' use \code{flair_rx} for regular expressions.
 #' @param before String giving specific html tags to insert before matched text.
@@ -48,12 +48,12 @@ flair_rx <- function(x, pattern,
   UseMethod("flair_rx")
 }
 
-#' S3 method for \code{\link{with_flair}} objects
+#' S3 method for \code{\link{decorated}} objects
 #'
 #' @importFrom purrr map
 #' @rdname flair
 #' @export
-flair_rx.with_flair = function(x, pattern,
+flair_rx.decorated = function(x, pattern,
                                before = NULL, after = NULL,
                                ...) {
 
@@ -68,7 +68,7 @@ flair_rx.with_flair = function(x, pattern,
   x[where_sources] <- purrr::map(x[where_sources],
                                  function(x) structure(list(src = x), class = "source"))
 
-  attr(x, "class") <- "with_flair"
+  attr(x, "class") <- "decorated"
 
   return(x)
 
@@ -159,7 +159,7 @@ flair_all.default <- function(x, ...) {
 
 #' @rdname flair
 #' @export
-flair_all.with_flair <- function(x, ...) {
+flair_all.decorated <- function(x, ...) {
 
   where_sources <-  map(x, ~attr(.x, "class")) == "source"
 
@@ -171,7 +171,7 @@ flair_all.with_flair <- function(x, ...) {
   x[where_sources] <- purrr::map(x[where_sources],
                                  function(x) structure(list(src = x), class = "source"))
 
-  attr(x, "class") <- "with_flair"
+  attr(x, "class") <- "decorated"
 
   return(x)
 

R/flair_lines.R

@@ -3,9 +3,9 @@
 #'
 #' \code{flair_lines} returns a string with formatting wrappers(currently only
 #' html), or applies the formatting to the source elements of a
-#' \code{\link{with_flair}} object.
+#' \code{\link{decorated}} object.
 #'
-#' @param x A string or \code{\link{with_flair}} object
+#' @param x A string or \code{\link{decorated}} object
 #' @param lines Integer vector indicating which lines to apply the flair styling to.
 # @param ... Formatting style options, passed to \code{\link{txt_style}}
 #'
@@ -38,21 +38,21 @@ flair_lines.default <- function(x, lines) {
 
 }
 
-#' S3 method for \code{\link{with_flair}} objects
+#' S3 method for \code{\link{decorated}} objects
 #'
 #' Applies flair to the appropriate line(s) of source code.
 #'
-#' @param x An object of class \code{\link{with_flair}}.
+#' @param x An object of class \code{\link{decorated}}.
 #' @param lines An integer vector specifying code lines to highlight.
 # @param ... Formatting style options, passed to \code{\link{txt_style}}
 #'
-#' @return An object of class \code{\link{with_flair}}.
+#' @return An object of class \code{\link{decorated}}.
 #'
 #' @importFrom stringr str_split str_trim str_remove_all
 #' @importFrom purrr map map2
 #'
 #' @export
-flair_lines.with_flair <- function(x, lines) {
+flair_lines.decorated <- function(x, lines) {
 
   where_sources <-  map(x, ~attr(.x, "class")) == "source"
 
@@ -74,7 +74,7 @@ flair_lines.with_flair <- function(x, lines) {
 
   #x <- c(x, script)
 
-  attr(x, "class") <- "with_flair"
+  attr(x, "class") <- "decorated"
 
   return(x)
 

R/txt_style.R

@@ -6,7 +6,7 @@
 #' \code{txt_*} are shortcuts for specific individual style options
 #'
 #' Warning: These are simple direct wrappers for strings only.  If you are using
-#' \code{\link{with_flair}} objects, you should instead use the
+#' \code{\link{decorated}} objects, you should instead use the
 #' \code{\link{flair}} functions.
 #'
 #' @param x The string to be wrapped