assign_map: Assign edges to the hex grid

Description Usage Arguments

View source: R/main.R

Description

Given an PlasmoMAPI project with a hex map already created, determine which edges intersect each hex. Assumes an elliptical projection with the start- and end-points of an edge becoming the two foci of an ellipse.

Usage

1
2
3
4
5
6
assign_map(
  proj,
  eccentricity = 0.9,
  report_progress = TRUE,
  pb_markdown = FALSE
)

Arguments

proj

object of class pm_project.

eccentricity

eccentricity of ellipses, defined as half the distance between foci divided by the semi-major axis. e = sqrt{1 - b^2/a^2}, where e is the eccentricity, a is the length of the semi-major axis, and b is the length of the semi-minor axis. Eccentricity ranges between 0 (perfect circle) and 1 (straight line between foci).

report_progress

if TRUE then a progress bar is printed to the console during the permutation testing procedure.

pb_markdown

whether to run progress bars in markdown mode, in which case they are updated once at the end to avoid large amounts of output.


mrc-ide/PlasmoMAPI documentation built on Oct. 1, 2020, 9:41 a.m.