R/calculateTrypticity.R

In devonjkohler/MSstatsLiP: LiP Significance Analysis in shotgun mass spectrometry-based proteomic experiments

#' Calculates level of trypticity for a list of LiP Peptides.
#'
#' Takes as as input LiP data and a fasta file. These can be the outputs of
#' MSstatsLiP functions.
#'
#' @export
#'
#' @param LiP_data name of variable containing LiP data. Must contain at least
#' two columns named 'PeptideSequence' and 'ProteinName'. The values in these
#' column must match with what is in the corresponding FASTA file.
#' @param fasta_file name of variable containing FASTA data. If FASTA file has
#' not been processed please run the tidyFasta() function on it before inputting
#' into this function.
#' @return a `data.frame` including protein, peptide, and trypticity metrics.
#' @examples
#' fasta <- tidyFasta(system.file("extdata", "ExampleFastaFile.fasta", package="MSstatsLiP"))
#' calculateTrypticity(MSstatsLiP_data$LiP, fasta)
calculateTrypticity <- function(LiP_data, fasta_file){

  unique_pep <- unique(LiP_data[, c("PeptideSequence",
                                    "ProteinName")])

  if (identical(typeof(fasta_file), "character")){
    fasta_file <- tidyFasta(fasta_file)
  }

  ## Add fasta file to get full sequence
  combined_df <- merge(unique_pep, fasta_file, all.x = TRUE,
                       by.x = "ProteinName", by.y = "uniprot_iso")

    ## Identify pre/end/post AA
  combined_df$start <- mapply(function(x,y){gregexpr(x, y)[[1]][1] - 1},
                              combined_df$PeptideSequence, combined_df$sequence)
  combined_df$end <- combined_df$start + nchar(combined_df$PeptideSequence)
  combined_df$preAA <- mapply(function(x,y) {substr(y, x, x)},
                              combined_df$start, combined_df$sequence)
  combined_df$endAA <- mapply(function(x,y) {substr(y, x, x)},
                              combined_df$end, combined_df$sequence)
  combined_df$postAA <- mapply(function(x,y) {substr(y, x, x)},
                               combined_df$end + 1, combined_df$sequence)

  ## Determine trip
  combined_df$fully_TRI <- (combined_df$preAA %in% c("K", "R") &
                                    combined_df$endAA %in% c("K", "R"))
  combined_df$NSEMI_TRI <- (combined_df$preAA %in% c("K", "R") &
                                    !combined_df$endAA %in% c("K", "R"))
  combined_df$CSEMI_TRI <- (!combined_df$preAA %in% c("K", "R") &
                                    combined_df$endAA %in% c("K", "R"))
  combined_df$CTERMINUS <- combined_df$postAA == ""
  combined_df$NTERMINUS <- combined_df$start == 1
  combined_df$StartPos <- combined_df$start
  combined_df$EndPos <- combined_df$end

  return(combined_df[, c("ProteinName", "PeptideSequence", "fully_TRI",
                         "NSEMI_TRI", "CSEMI_TRI", "CTERMINUS", "NTERMINUS",
                         "StartPos", "EndPos")])
}