Learn R Programming

geocausal (version 0.3.4)

get_distexp: Get the expectation of treatment events with arbitrary distances

Description

`get_distexp()` takes counterfactual densities and and returns the expected number of treatment events based on distances from a user-specified focus.

Usage

get_distexp(
  cf_sim_results,
  entire_window,
  dist_map,
  dist_map_unit = "km",
  use_raw = FALSE
)

Value

A list of resulting dataframe (`result_data`), windows (`window_list`), data for distance quantiles, and a window object for the entire window

Arguments

cf_sim_results

output of `sim_cf_dens()`

entire_window

owin object of the entire region

dist_map

im object whose cell values are the distance from a focus (e.g., city)

dist_map_unit

either `"km"` or `"mile"`

use_raw

logical. `use_raw` specifies whether to use the raw value of expectations or percentiles. By default, `FALSE`.