Count.rays: Count.rays

View source: R/places and rays fcns.R

Count.raysR Documentation

Count.rays

Description

given the geoid of a place and sf objects containing hwy information and place information, this calls each step to count the rays. Returns the number of rays for the place and a map of them. Arguments are passed to wrapped fcns. Additional arguments can also be passed to mapview::mapview to change appearance of output map.

Usage

Count.rays(
  place.geoid,
  hwy.sf,
  place.sf = divM::largest.plc.in.cz,
  remove.holes = FALSE,
  ...
)

Arguments

place.geoid

7-character identifier for place to generate rays for.

hwy.sf

Sf object that represents highways with NHPN SIGNT1 & SIGN1 columns

place.sf

Sf object with geoid column to subset to.

remove.holes

Remove holes from places before counting rays. If a hwy starts/ends in a hole, it will be counted as a ray unless this is set to TRUE

...

Arguments passed on to trim.to.length.floors, hwys2endpoints, initial.hwy2ray.subset, Get.bundled.ray.output

minimum.segment.length

Minimum length (meters) that each highway ~segment~ must have in order to be eligible for rays, This differs from minimum.hwy.length in that it filters by each separate segment, rather than overall hwy length

minimum.hwy.length

Minimum length of each ~highway~ that must be inside place boundaries for it to be ray-eligible. Differs from minimum.segment.length in that at least one segment of hwy must meet this threshold for ~any~ of the segments to be eligible. Only relevant if larger than minimum.segment.length.

fill.gaps

whether or not to fill gaps between highway segments. Argument threshold can also be supplied specify maximum gap distance to fill gap btwn.

place

Single polygon, likely representing a Place, for which to generate rays.

always.include

Type(s) of highways to always include for ray measure if include.intersecting is false. By default only interstates

include.intersecting

Whether or not to include additional highway types if they intersect with one or more of the core/always included hwy types.

hwy.types

Other types of hwys to include if and only if they intersect with the core, "always.included" type(s). Only relevant if include.intersecting is true. No filter applied if left as NULL (default).

drop.NA

Whether to drop rows with NA in the SIGNT hwy-type identifier column.

buffer.meters

Amount of padding around the Place to retain when trimming highways to place and surrounding area. Defaults to 300 meters.

trimmed.hwys

hwys prepped for supplied place, as with initial.hwy2ray.subset

verbose

Display additional text output in console. Makes explicit some parameters that are passed to wrapped fcns and will say where ineligible rays are removed due to issue described above.


kmcd39/divM documentation built on Oct. 21, 2023, 11:28 p.m.