GeoMAPI_plot_zscore: Plot GeoMAPI z-scores and significance

View source: R/plot.R

GeoMAPI_plot_zscoreR Documentation

Plot GeoMAPI z-scores and significance

Description

TODO

Usage

GeoMAPI_plot_zscore(
  project,
  plot_sampling_points = TRUE,
  plot_significance = TRUE,
  min_hex_coverage = 10,
  col_scale = viridisLite::viridis,
  zlim = NULL,
  base_plot = NULL,
  point_size = 1,
  point_colour = "white",
  point_fill = "black",
  point_stroke = 0.2
)

Arguments

project

a genescaper project, as produced by the genescaper_project() function.

plot_sampling_points

whether to overlay sampling locations.

plot_significance

whether to outline areas that were identified as significant outliers.

min_hex_coverage

minimum coverage (number of edges assigned to a hex) for it to be included in the final result, otherwise these hexes are given the value NA.

col_scale

the colour scale to use.

zlim

the limits of the colour scale. If NULL then these limits are chosen automatically.

base_plot

optional base plot (object of class ggplot) on which this function builds. If NULL then a simple empty plot is used.

point_size, point_colour, point_fill, point_stroke

properties of plotted sampling points.


mrc-ide/genescaper documentation built on May 25, 2022, 10:46 p.m.