build_map_report: Creates a summary report of polygon maps

Description Usage Arguments Value Examples

Description

Creates a summary report of polygon maps

Usage

1
2
3
build_map_report(outDir = getwd(), region = "Kaduna",
  survey_points_path = "../1_data", polygon_dir = "../2_results",
  addDate = TRUE)

Arguments

outDir

the output directory. Defaults to the current working directory

region

the name of the region. Used to add a title to the report and for file naming

survey_points_path

the file path to the survey points dataset

polygon_dir

the file path to the survey polygons

Value

Creates a HTML report containing an interactive map for each polygon

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# Load Data from the package
path_data <- system.file("extdata", package = "polyCheck")

# Settlement types
path_polygons <- file.path(path_data, "polygons")
path_survey_points <-  file.path(path_data, "survey_points_sample.shp")
directory <- file.path(getwd(), "reports")

# Builds a summary report
build_map_report(outDir = directory,
                 survey_points_path = path_survey_points,
                 polygon_dir = path_polygons,
                 addDate = FALSE)

GRID3/polyCheck documentation built on May 26, 2019, 8:35 a.m.