Update R data pkg

.Rbuildignore

@@ -0,0 +1,7 @@
+^\.Rproj\.user$
+^\.github$
+^\.git$
+^data-raw$
+^README.md$
+^\.gitignore$
+^PEMAD-OWEB-Survey_Interactions\.Rproj$

.gitignore

@@ -1 +1,4 @@
-
+.Rproj.user
+.git
+data-raw/
+*.Rproj

DESCRIPTION

@@ -0,0 +1,20 @@
+Package: surveyInteractions
+Title: Survey Preclusion Zones
+Version: 0.0.1
+Authors@R: 
+    person(given = 'Joshua',
+           family = 'Hatch',
+           role = c('aut', 'cre'),
+           email = '[email protected]')
+Description: Spatial data defining preclusion zones for station reallocation.
+License: file LICENSE
+Encoding: UTF-8
+LazyData: true
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.2
+Depends: 
+    R (>= 2.10),
+    sf
+Suggests: 
+    dplyr
+URL: https://github.com/jmhatch-NOAA/PEMAD-OWEB-Survey_Interactions

LICENSE

@@ -0,0 +1,8 @@
+“Software code created by U.S. Government employees is not subject to
+copyright in the United States (17 U.S.C. §105). The United States/Department
+of Commerce reserve all rights to seek and obtain copyright
+protection in countries other than the United States for Software authored
+in its entirety by the Department of Commerce. To this end, the Department
+of Commerce hereby grants to Recipient a royalty-free, nonexclusive
+license to use, copy, and create derivative works of the Software outside
+of the United States.”

NAMESPACE

@@ -0,0 +1,2 @@
+# Generated by roxygen2: do not edit by hand
+

R/data_preclusion_zones.R

@@ -0,0 +1,30 @@
+#' @title Preclusion Zones
+#'
+#' @description An \code{sf} collection containing preclusion zones that can be used to reallocate stations during survey design for NEFSC surveys that are strata-based.
+#' A preclusion zone is the union of 1-nautical mile buffers around turbine and substation locations and includes the export cable corridor.
+#'
+#' @format An \code{sf} collection:
+#' \describe{
+#'   \item{TYPE}{A character string that describes the meaning of the GEOMETRY. Can be Preclusion Zone, Turbine(s), or Substation(s).}
+#'   \item{LEASE_NUMBER}{A character string that documents the assigned BOEM lease number.}
+#'   \item{PROJECT_NAME}{A character string that documents the offshore wind project name.}
+#'   \item{DEVELOPER_NAME}{A character string that documents the offshore wind developer.}
+#'   \item{STATUS}{A character string that indicates the status of the lease area. Can be Operational, under Construction, or Proposed.}
+#'   \item{geometry}{An \code{sf} GEOMETRY object that can be a POLYGON, POINT, or MULTIPOINT.}
+#' }
+#'
+#' @docType data
+#' @name preclusion_zones
+#' @usage data("preclusion_zones")
+#' @keywords datasets
+#' @source \url{https://www.boem.gov/renewable-energy/mapping-and-data/renewable-energy-gis-data}
+#' @examples
+#' \dontrun{
+#' # load pkg
+#' library(NEFSC-PEMAD-OWEB-Survey_Interactions)
+#'
+#' # visualize
+#' plot(preclusion_zones['TYPE'])
+#' }
+NULL
+

README.md

@@ -1,13 +1,13 @@
-# PEMAD-OWEB-Survey_Interactions
+# surveyInteractions
 
-[![gitleaks](https://github.com/jmhatch-NOAA/PEMAD-OWEB-Survey_Interactions/actions/workflows/secretScan.yml/badge.svg)](https://github.com/jmhatch-NOAA/PEMAD-OWEB-Survey_Interactions/actions/workflows/secretScan.yml) 
+[![gitleaks](https://github.com/jmhatch-NOAA/surveyInteractions/actions/workflows/secretScan.yml/badge.svg)](https://github.com/jmhatch-NOAA/surveyInteractions/actions/workflows/secretScan.yml) 
 
 A repository of survey preclusion zones in simple features [`sf`](https://r-spatial.github.io/sf/) format stored in an *.rda file for use with [`R`](https://www.r-project.org/).
 
 ### Installation
 
 ```r
-devtools::install_github('jmhatch-NOAA/PEMAD-OWEB-Survey_Interactions')
+devtools::install_github('jmhatch-NOAA/surveyInteractions')
 ```
 
 ### Legal disclaimer