rangeMapper connect

Source: R/1_set.R

Connect to a new or an existing rangeMapper project.

rmap_connect(path = ":memory:", overwrite = FALSE)

Arguments

path

filepath . When not specified, an in-memory file is created.
overwrite

when TRUE, the file is removed and the project re-initiated.

Value

an object of class rmapConnection

Details

An empty rangeMapper file is an sqlite database with five system tables:

  • rmap_nfo containing the package version, the crs string, the canvas type and the bounding box.

  • rmap_master a table similar with the in-build sqlite_master table holding information about the tables created or importing while working on the project.

  • canvas_ranges a table that makes the link between the canvas and any entities usually species mapped on the canvas.

  • wkt_canvas a table containing the canvas polygons as wkt binary.

  • wkt_ranges a table containing the range polygons (usually species distribution ranges) as wkt binary.

If any of system tables is changed or missing then the file is considered corrupted and cannot be open with rmap_connect().

Examples

require(rangeMapper)
con = rmap_connect()
class(con)

#> [1] "rmapConnection"
#> attr(,"package")
#> [1] "rangeMapper"
dbDisconnect(con)