R: Register a new dataseries

regDataseries {arealDB}

R Documentation

Register a new dataseries

Description

This function registers a new dataseries of both, geometries or areal data into the geospatial database. This contains the name and relevant meta-data of a dataseries to enable provenance tracking and reproducability.

Usage

regDataseries(
  name = NULL,
  description = NULL,
  homepage = NULL,
  licence_link = NULL,
  licence_path = NULL,
  notes = NULL,
  update = FALSE,
  overwrite = FALSE
)

Arguments

`name`	[`character(1)`] the dataseries abbreviation or name.
`description`	[`character(1)`] the "long name" or "brief description" of the dataseries.
`homepage`	[`character(1)`] the homepage of the data provider where the dataseries or additional information can be found.
`licence_link`	[`character(1)`] link to the licence or the webpage from which the licence was copied.
`licence_path`	[`character(1)`] path to the local file in which the licence text is stored.
`notes`	[`character(1)`] optional notes.
`update`	[`logical(1)`] whether or not the file 'inv_dataseries.csv' should be updated (obligatory to continue registering geometries or tables associated to this dataseries).
`overwrite`	[`logical(1)`] whether or not the dataseries to register shall overwrite a potentially already existing older version.

Value

Returns a tibble of the new entry that is appended to 'inv_dataseries.csv' in case update = TRUE.

Examples

if(dev.interactive()){
  # start the example database
  makeExampleDB(until = "match_gazetteer", path = tempdir())

  regDataseries(name = "gadm",
                description = "Database of Global Administrative Areas",
                homepage = "https://gadm.org/index.html",
                licence_link = "https://gadm.org/license.html",
                update = TRUE)
}