GeoMAPI_suggest_eccentricity: Suggest eccentricity parameter based on target coverage
In mrc-ide/genescaper: Allele frequency mapping and outlier detection

GeoMAPI_suggest_eccentricity

R Documentation

Suggest eccentricity parameter based on target coverage

Description

TODO

Usage

GeoMAPI_suggest_eccentricity(
  project,
  target_coverage = 10,
  target_proportion = 0.9,
  n_iterations = 30,
  max_dist = Inf,
  silent = FALSE,
  pb_markdown = FALSE
)

Arguments

`project`	a genescaper project, as produced by the `genescaper_project()` function.
`target_coverage, target_proportion`	eccentricity will be chosen such that a proportion `target_proportion` of cells achieve a coverage of at least `target_coverage`.
`n_iterations`	the number of iterations to run of the binary search method.
`max_dist`	edges shorter than this length are discarded prior to assignment. Can be used to focus on short distance signals.
`silent`	if `TRUE` then no output is produced during function evaluation.
`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.