R/plotKL.R

In forensIT: Information Theory Tools for Forensic Analysis

#' @title Plot KL distances.
#' @description Plot KL distances.
#' @param res output from distKL function.
#' @return A scatterplot.
#' @export
#' @import ggplot2
#'
#' @examples
#' library(forrel)
#' x = linearPed(2)
#' plot(x)
#' x = setMarkers(x, locusAttributes = NorwegianFrequencies[1:5])
#' x = profileSim(x, N = 1, ids = 2)
#' res <- distKL(ped = x, missing = 5, relative = 1,
#' cores = 1, frequency = NorwegianFrequencies[1:5], numsims = 5)
#' plotKL(res)
plotKL <- function(res) {
  ggplot(res, aes(x= res$KLpopped, y= res$KLpedpop)) +
  geom_point(size=2, alpha = 0.5) + theme(text = element_text(size = 20)) +
  xlab("KL population to ped") + ylab("KL ped to population") +
  scale_x_continuous(limits = c(0, max(res$KLpopped+0.1)),
                       expand = c(0, 0)) +
  scale_y_continuous(limits = c(0, max(res$KLpedpop+0.1)),
                     expand = c(0, 0))}