Merge pull request #30 from rempsyc/document_data

Properly document lflags :D

Author: jimjam-slam

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ggflags
 Type: Package
-Version: 0.0.3
+Version: 0.0.4
 Title: Plot flags of the world in ggplot2
 Authors@R: c(
   person("Baptiste", "Auguie",

NEWS.md

@@ -1,3 +1,9 @@
+# ggflags 0.0.4
+
+- Some more internal rejiggering to ensure that you can use ggflags without explicitly loading the package
+  - If you're not loading the package and need to use it to plot things, prefix the package functions with `ggflags::` (eg. `ggflags::geom_flag`).
+  - If you need to access the internal flag list, either load it into the global environment as `lflags` using `data(lflags)` or access it prefixed with `ggflags::lflags`
+
 # ggflags 0.0.3
 
 - Adds Rémi Thériault as an author and contributor!

R/geom_flag.R

@@ -67,7 +67,7 @@ makeContent.flag <- function(x) {
     seq_along(x$country),
     function(ii) {
       grImport2::pictureGrob(
-        picture = .flaglist[[x$country[[ii]]]],
+        picture = ggflags::lflags[[x$country[[ii]]]],
         x = x$x[ii], y = x$y[ii],
         width = x$size[ii] * grid::unit(1, "mm"),
         height = x$size[ii] * grid::unit(1, "mm"),
@@ -77,6 +77,3 @@ makeContent.flag <- function(x) {
   )
   grid::setChildren(x, do.call(grid::gList, flag_pics))
 }
-
-#' @noRd
-utils::globalVariables(c(".flaglist"))

R/lflags.R

@@ -1,11 +1,11 @@
 #' List of country flags
 #'
 #' @docType data
-#' @format A data frame with X rows and X variables:
+#' @format A list of 256 elements of class S4 (`grImport::Picture`), with:
 #' \describe{
-#'   \item{state.name}{the name of the state}
-#'   \item{state.abb}{the name of the abbreviation}
-#'   \item{state.regex}{the regex for that state}
+#'   \item{content}{PictureGroup}
+#'   \item{defs}{PictureDefinitions}
+#'   \item{summary}{PictureSummary}
 #'   ...
 #' }
-".flaglist"
+"lflags"