From 46b742113ebef108ccd3ece574e8c11b583c6b2d Mon Sep 17 00:00:00 2001
From: Martin Jung <martinjung@zoho.com>
Date: Thu, 5 Dec 2024 11:08:30 +0100
Subject: [PATCH] Adding datapaths as entry

---
 DESCRIPTION            |   1 +
 R/data.R               |  24 ++++++++++++++++++++++++
 data/bnr_datapaths.rda | Bin 0 -> 265 bytes
 man/bnr_datapaths.Rd   |  35 +++++++++++++++++++++++++++++++++++
 4 files changed, 60 insertions(+)
 create mode 100644 R/data.R
 create mode 100644 data/bnr_datapaths.rda
 create mode 100644 man/bnr_datapaths.Rd

diff --git a/DESCRIPTION b/DESCRIPTION
index 3f08042..d860387 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -27,3 +27,4 @@ Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
 Config/testthat/edition: 3
+LazyData: true
diff --git a/R/data.R b/R/data.R
new file mode 100644
index 0000000..a96fa12
--- /dev/null
+++ b/R/data.R
@@ -0,0 +1,24 @@
+#' Table with default paths to commonly used spatial input files
+#'
+#' @description
+#' This dataset contains path names to commonly-used spatial data files. Given that
+#' those files are usually quite large, we here only describe where to find them internally
+#' and not upload the data itself.
+#' Medium-long-term this could be improved by relying on github LFS systems or our own gitlab
+#' instance.
+#'
+#' @details
+#' The file has the following columns:
+#'
+#' [*] 'drive': The path to drive where the data is stored (Default: \code{'P:/bnr/'}). Can be system dependent (Windows/Linux).
+#' [*] 'access': A non-structured field containing the list of people that have access (for example \code{'IBF'} or \code{'bnr'}).
+#' [*] 'group': A field entry describing to what this file belongs to (i.e. \code{"EPIC"}).
+#' [*] 'filename': The actual filename
+#'
+#' @note
+#' To update or overwrite, load the file and update, then apply
+#' \code{usethis::use_data(bnr_datapaths, overwrite = TRUE) }.
+#'
+#' @format A [data.frame] containing paths to key spatial data sources.
+#' @source Manually updated and curated by BNR researchers
+"bnr_datapaths"
diff --git a/data/bnr_datapaths.rda b/data/bnr_datapaths.rda
new file mode 100644
index 0000000000000000000000000000000000000000..6a94d12d504e10ee88984879efe13036b5a066c8
GIT binary patch
literal 265
zcmV+k0rvhvT4*^jL0KkKS)sCA5dZ*y|G@w9NB}?q&=3@++CabO-=IJM00FQ7*)|%f
z=`wi&X|*zF$)iRY5MxaUA~gWQPg6`xAO@HTf?yb>JW-+QG|&J54FRTu)QlPsNh>gg
zrpZtdLYjy-GIS#r5*m#3rVs#?5iqXyIR~H|1JD8F6iEn#ScoBrk~n2!U=SL|6Rs!P
z&g0Qr{t$qhyv<;VAfeG{EanOn-88)Ve9T*vODO|O#kD>}3J*~|@2VfMosL6SpjjCa
zwq+|X&w3GoP#J;K#V-KrARrvli3ravP8~KfivMCf$5%5`g)p|XlGwzWfwzL|FVi@Q
PU&Y*!P81|4Y?lN;Qxa<M

literal 0
HcmV?d00001

diff --git a/man/bnr_datapaths.Rd b/man/bnr_datapaths.Rd
new file mode 100644
index 0000000..ca5cee2
--- /dev/null
+++ b/man/bnr_datapaths.Rd
@@ -0,0 +1,35 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/data.R
+\docType{data}
+\name{bnr_datapaths}
+\alias{bnr_datapaths}
+\title{Table with default paths to commonly used spatial input files}
+\format{
+A \link{data.frame} containing paths to key spatial data sources.
+}
+\source{
+Manually updated and curated by BNR researchers
+}
+\usage{
+bnr_datapaths
+}
+\description{
+This dataset contains path names to commonly-used spatial data files. Given that
+those files are usually quite large, we here only describe where to find them internally
+and not upload the data itself.
+Medium-long-term this could be improved by relying on github LFS systems or our own gitlab
+instance.
+}
+\details{
+The file has the following columns:
+
+\link{*} 'drive': The path to drive where the data is stored (Default: \code{'P:/bnr/'}). Can be system dependent (Windows/Linux).
+\link{*} 'access': A non-structured field containing the list of people that have access (for example \code{'IBF'} or \code{'bnr'}).
+\link{*} 'group': A field entry describing to what this file belongs to (i.e. \code{"EPIC"}).
+\link{*} 'filename': The actual filename
+}
+\note{
+To update or overwrite, load the file and update, then apply
+\code{usethis::use_data(bnr_datapaths, overwrite = TRUE) }.
+}
+\keyword{datasets}