iconr (version 0.1.0)

read_nds: Read Nodes of a Decoration

Description

Read nodes' information from a file including all nodes and extract nodes of one decoration. Accepted formats are tab separated values ('tsv'), semicolon separated values ('csv'), or shapefile ('shp').

Usage

read_nds(site,
        decor,
        dir = getwd(),
        nodes = "nodes",
        format = "tsv")

Arguments

site

Name of the site

decor

Name of the decoration

dir

Path to the working folder, by default it is the working directory

nodes

Name of the nodes file (a dataframe or a shapefile)

format

File extension indicating a file format from 'tsv' (tab separated values), 'csv' (semicolon separated values) or 'shp' (shapefile). For 'tsv' and 'csv' the files must include node coordinates (nodes$x, nodes$y).

Value

Dataframe of graph nodes, including at least the columns "site", "decor", "id", "x", "y", with values for each node (row).

Examples

# NOT RUN {
# Set data folder
dataDir <- system.file("extdata", package = "iconr")

# Read dataframe of nodes
nds.df <- read_nds(site = "Cerro Muriano", decor = "Cerro Muriano 1",
                    dir = dataDir, format = "tsv")
nds.df
## Dataframe of nodes

# Read shapefile of nodes
nds.df <- read_nds(site = "Cerro Muriano", decor = "Cerro Muriano 1",
                    dir = dataDir, format = "shp")
nds.df
## Dataframe of nodes

# }