R/plotNiCuDupKRs.R

In jrminter/rWrapStrataGem: Generate .ini files for StrataGem wrapper applications

#' Plot experimental and model K-ratio data from a single duplicate Ni/Cu//PET
#' 
#' A helper function to plot results
#'
#' @param df A data frame with e0 and K-ratios for NiK and CuK for the duplicate \code{df}
#'
#' @param name The name for the title or "" to supress \code{name}
#'
#' @param modelPath Path to the StratagGEM model csv file or "" to suppress \code{modelPath}
#'
#' @return nothing but the plot
#'
#' @keywords keywords
#'
#' @export
#'
#' @examples
#' # library(rWrapStrataGem)
#' # plotNiCuDupKRs(qm.04029.kr.d1, '84-10A-6m-d1', '../csv/qm-04029-84-10A-d1-SG-Model.csv')
#' 
plotNiCuDupKRs <- function(df, name="", modelPath=""){
  x <- c(min(df$e0), max(df$e0))
  y <- c(0,1)
  if(name != ""){
    plot(x,y,type='n', xlab="kV", ylab="K-Ratio", main=name)
  } else {
    plot(x,y,type='n', xlab="kV", ylab="K-Ratio")
  }
  points(df$e0, df$krNiK, pch=16, col='red')
  points(df$e0, df$krCuK, pch=17, col='blue')
  if(modelPath !=""){
    dfc <- read.csv(modelPath, header=TRUE, as.is=TRUE)
    dfc <- dfc[dfc$kV >= min(df$e0), ]
    dfc <- dfc[dfc$kV <= max(df$e0), ]
    lines(dfc$kV, dfc$NiKR, col='red')
    lines(dfc$kV, dfc$CuKR, col='blue')
  }
  legend("topright", c("NiK","CuK"),
         col=c('red', 'blue'), pch=c(16,17))
}