Package it up

.Rbuildignore

@@ -1,3 +1,5 @@
 ^.git$
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^_EXAMPLES$
+^README\.Rmd$

DESCRIPTION

@@ -1,14 +1,20 @@
 Package: plot2
 Type: Package
-Title: What the Package Does Using Title Case
-Version: 1.0
+Title: Lightweight extension of the base R plot function, with support for
+ automatic grouping and legend printing, and several other enhancements
+Version: 0.0.0.9000
 Date: 2023-02-21
 Author: Grant McDermott
 Maintainer: Grant McDermott <grant.mcdermott@gmail.com>
-Description: More details about what the package does. See
- <http://cran.r-project.org/doc/manuals/r-release/R-exts.html#The-DESCRIPTION-file>
- for details on how to write this part.
-License: GPL (>= 2)
-Suggests: tinytest
+Description: Making base plot less painful.
+License: GPL (>= 2) 
+Depends:
+ R (>= 3.3)
+Imports: 
+ graphics,
+ grDevices
+Suggests:
+ tinytest,
+ basetheme
 Encoding: UTF-8
 RoxygenNote: 7.2.3

NAMESPACE

@@ -1,3 +1,18 @@
-## export all regularly named functions
-## (but allow for private functions whose name starts with a dot).name <- function(...)
-exportPattern("^[[:alpha:]]+")
+# Generated by roxygen2: do not edit by hand
+
+S3method(plot2,default)
+S3method(plot2,formula)
+export(plot2)
+importFrom(grDevices,hcl.colors)
+importFrom(grDevices,hcl.pals)
+importFrom(grDevices,palette.colors)
+importFrom(grDevices,palette.pals)
+importFrom(graphics,axis)
+importFrom(graphics,box)
+importFrom(graphics,grconvertX)
+importFrom(graphics,lines)
+importFrom(graphics,par)
+importFrom(graphics,plot.new)
+importFrom(graphics,plot.window)
+importFrom(graphics,points)
+importFrom(graphics,title)

R/plot2-package.R

@@ -0,0 +1,21 @@
+#' \code{plot2-package}
+#'
+#' @title plot2: Lightweight extension of the base R plot function, with support
+#' for automatic grouping and legend printing, and several other enhancements
+#'
+#' @description The goal of **plot2** is to extend the functionality of base R's
+#' default (2D) `plot()` function, particularly as it applies to scatter and
+#' line plots with grouped data. For example, **plot2** makes it easy to plot
+#' different categories of a dataset in a single function call and highlight
+#' these categories (groups) using modern colour palettes. Coincident with
+#' this grouping support, **plot2** also produces automatic legends with scope
+#' for further customization. While the package also offers several other
+#' minor enhancements, it tries as far as possible to be a drop-in replacement
+#' for the equivalent base plot function. Users should be able to swap a valid
+#' `plot` call with `plot2` without any changes to the expected output.
+#'
+#' @docType package
+#' @aliases plot2-package
+#' @name plot2-package
+#' @keywords internal
+"_PACKAGE"