Updating examples

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: prettyB
 Type: Package
 Title: Pretty Base Graphics
-Version: 0.1.0
+Version: 0.1.1
 Authors@R: person(given="Colin", family="Gillespie",
     email="[email protected]", role = c("aut", "cre"))
 Maintainer: Colin Gillespie <[email protected]>

NEWS.md

@@ -1,2 +1,5 @@
+## Version 0.1.1
+  * Adding examples to ?plot
+
 ## Version 0.1.0
   * Initial version

R/plot.R

@@ -7,6 +7,16 @@
 #' @export
 #' @import graphics stats
 #' @rdname plot
+#' @examples
+#' # PrettyB overloads standard plotting functions
+#' plot(1:10)
+#' # All arguments still work as expect
+#' plot(iris$Sepal.Length, iris$Sepal.Width, bg = "red")
+#' # Use par as usual
+#' op = par(mfrow = c(1, 2))
+#' plot(rnorm(10), xlab = "X")
+#' plot(rnorm(10), main = "A title")
+#' par(op)
 plot = function (x, y, ...) UseMethod("plot")
 
 ## XXX: Make formula pretty - need to grab x & y

R/prettyB-package.R

@@ -0,0 +1,12 @@
+#' The prettyB package
+#'
+#' Anyone who uses R Base graphics, have a 100 and 1 tweaks that they use to make the
+#' figures more presentable. This package aims to capture the tweaks in one place.
+#' By masking_standard plotting functions, we can automatically make base graphics a bit more pretty.
+#' @name prettyB-package
+#' @aliases prettyB prettyb prettyB-package
+#' @docType package
+#' @author \email{[email protected]}
+#' @keywords package
+#' @seealso \url{https://github.com/jumpingrivers/prettyB}
+NULL

README.Rmd

@@ -55,7 +55,7 @@ The second `plot()` function call is from the **prettyB** package.
 
 There are currently two themes: `expand` and `minimal`(default):
 
-```{r, plot-expand, fig.width=12, echo=c(-1, -5)}
+```{r, plot-expand, fig.width=12, echo=-5}
 theme_set("expand")
 par(mfrow = c(1, 2))
 graphics::plot.default(iris$Sepal.Length, iris$Sepal.Width, 

README.md

@@ -46,6 +46,7 @@ The second `plot()` function call is from the **prettyB** package.
 There are currently two themes: `expand` and `minimal`(default):
 
 ``` r
+theme_set("expand")
 par(mfrow = c(1, 2))
 graphics::plot.default(iris$Sepal.Length, iris$Sepal.Width, 
      main="Classic Iris Dataset", xlab="Length", ylab="Width")