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 0000000..6a94d12 Binary files /dev/null and b/data/bnr_datapaths.rda differ 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}