R/predictRelativeFreqIndels.R

In LihuaJulieZhu/CRISPRseek: Design of target-specific guide RNAs in CRISPR-Cas9, genome-editing systems

#' Predict insertions and deletions induced by CRISPR/Cas9 editing
#'
#' Predict insertions and deletions, and associated reletive frequecies induced by CRISPR/Cas9 editing
#'
#' @details Predict relative indel frequency around target sites of CRISPR/Cas9 system.
#' Currently only Lindel method using logistic regression is implemented in CRISPRseek.
#'
#' Lindel is compatible with both Python2.7 and Python3.5 or higher.
#'
#' By default, reticulate uses the version of Python found on your PATH (i.e. Sys.which("python")).
#'
#' Use the function use_python in reticulate library to set the python path to a specific version.
#' For example, use_python('/opt/anaconda3/lib/python3.7')
#'
#' \code{}This function implements the Lindel method
#'
#' @param extendedSequence A vector of DNA sequences of length 60bp. It consists 30bp before the cut site
#' and 30bp after the cut site.
#'
#' @param method the prediction method. default to Lindel. Currently only Lindel method are implemented.
#'
#' @return A list with the same length as the input extendedSequence. 
#'
#' Each list item either contains a warning message, or a predicted fraction of frameshift in the mutational outcomes plus
#' a data frame with three columns.
#'
#' The three columns are the alignment of predicted indel sequence to the original unedited sequence,
#' predicted indel frequency, and the location of the predicted indels.
#' The warning message for the Lindel method is as follows.
#'
#' Warning: No PAM sequence is identified. Please check your sequence and try again.
#'
#'
#' @examples
#' extendedSequence <- c("AAA", "TAACGTTATCAACGCCTATATTAAAGCGACCGTCGGTTGAACTGCGTGGATCAATGCGTC")
#' if (interactive())
#'     indelFreq <- predictRelativeFreqIndels(extendedSequence, method = "Lindel") 
#'
#' 
#' @references Wei Chen, Aaron McKenna, Jacob Schreiber et al.,
#' Massively parallel profiling and predictive modeling of the 
#' outcomes of CRISPR/Cas9-mediated double-strand break repair, 
#' Nucleic Acids Research, Volume 47, Issue 15, 05 September 2019, 
#' Pages 7989–8003, https://doi.org/10.1093/nar/gkz487

#' @author Hui Mao and Lihua Julie Zhu



#' Predict insertions and deletions induced by CRISPR/Cas9 editing
#' 
#' Predict insertions and deletions, and associated reletive frequecies induced
#' by CRISPR/Cas9 editing
#' 
#' Predict relative indel frequency around target sites of CRISPR/Cas9 system.
#' Currently only Lindel method using logistic regression is implemented in
#' CRISPRseek.
#' 
#' Lindel is compatible with both Python2.7 and Python3.5 or higher.
#' 
#' By default, reticulate uses the version of Python found on your PATH (i.e.
#' Sys.which("python")).
#' 
#' Use the function use_python in reticulate library to set the python path to
#' a specific version. For example, use_python('/opt/anaconda3/lib/python3.7')
#' 
#' \code{}This function implements the Lindel method
#' 
#' @param extendedSequence A vector of DNA sequences of length 60bp. It
#' consists 30bp before the cut site and 30bp after the cut site.
#' @param method the prediction method. default to Lindel. Currently only
#' Lindel method are implemented.
#' @return A list with the same length as the input extendedSequence.
#' 
#' Each list item either contains a warning message, or a predicted fraction of
#' frameshift in the mutational outcomes plus a data frame with three columns.
#' 
#' The three columns are the alignment of predicted indel sequence to the
#' original unedited sequence, predicted indel frequency, and the location of
#' the predicted indels. The warning message for the Lindel method is as
#' follows.
#' 
#' Warning: No PAM sequence is identified. Please check your sequence and try
#' again.
#' @author Hui Mao and Lihua Julie Zhu
#' @references Wei Chen, Aaron McKenna, Jacob Schreiber et al., Massively
#' parallel profiling and predictive modeling of the outcomes of
#' CRISPR/Cas9-mediated double-strand break repair, Nucleic Acids Research,
#' Volume 47, Issue 15, 05 September 2019, Pages 7989–8003,
#' https://doi.org/10.1093/nar/gkz487
#' @examples
#' 
#' extendedSequence <- c("AAA", "TAACGTTATCAACGCCTATATTAAAGCGACCGTCGGTTGAACTGCGTGGATCAATGCGTC")
#' if (interactive())
#'     indelFreq <- predictRelativeFreqIndels(extendedSequence, method = "Lindel") 
#' 
#' 
#' @importFrom reticulate py_config py_available py_install py_module_available source_python install_miniconda use_condaenv py_discover_config
#' @importFrom rhdf5 H5Fopen h5write h5createFile h5closeAll 
#' @export predictRelativeFreqIndels
predictRelativeFreqIndels <- function(extendedSequence, method = "Lindel")
{
   if (any(unlist(lapply(extendedSequence, nchar)) != 60))
        warning("Some of the sequences for predicting indel frequencies using Lindel are shorter than 60bp long!")
   if (method == "Lindel")
        e = "Warning: No PAM sequence is identified. Please check your sequence and try again"
   py_config()
   if (!py_available())
   {
        tryCatch((install_miniconda()), error = function(e) {print(e); })
        use_condaenv("r-reticulate")
   }
   pyv <- unlist(strsplit(py_discover_config()$version, ".", fixed = TRUE)) 
   if (!exists("pyv"))
     stop("Please install python first! Python 2.7, 3.5 or higher is required for predicting relative indel frequency!\n") 
   if((pyv[1] == 2 && pyv[2] >= 7) || (pyv[1] == 3 && pyv[2] >=5 ))
   {
        #unlink("pythonVersion.txt")
        if (! py_module_available("numpy"))
            py_install("numpy")
        if (! py_module_available("scipy"))
            py_install("scipy")
        if( ! py_module_available("pickle")) 
            py_install("pickle")
	if (! py_module_available("re"))
	     py_install("re")
	if (! py_module_available("json"))
             py_install("json")
        if (! py_module_available("setuptools"))
             py_install("setuptools")
        lindelDir <- system.file("extdata/Lindel", package = "CRISPRseek")
        oldDir <- getwd()
        if (dir.exists(lindelDir))
        {
            setwd(lindelDir)
            source_python("Predictor.py")
            source_python("RLindelprediction.py")
	    h5f1 = H5Fopen("model_weights1.h5")
	    h5f2 = H5Fopen("model_weights2.h5")
            h5f31 = H5Fopen("model_weights3_1.h5")
	    h5f32 = H5Fopen("model_weights3_2.h5")
            h5f4 = H5Fopen("model_weights4.h5")
            h5f5 = H5Fopen("model_weights5.h5")
            h5f6 = H5Fopen("model_weights6.h5") 
            m3 <- cbind(h5f31$m3.1, h5f32$m3.2)
            weights <- list(h5f1$m1, h5f2$m2, m3, h5f4$m4, h5f5$m5, h5f6$m6)

            #h5f = H5Fopen("model_prereq.h5")
            #prerequesites = h5f$model_prereq
            
            h5closeAll()
 
            tryCatch((
                indelFreq <- lapply(extendedSequence, function(thisSeq) {
                        res <- predIndelFreq(thisSeq, weights)
                        if (length(res) == 1 && res == e) {
                            return(list(fs = NA, indels = e))
                        }
                        else {
                            result <- t(data.frame(res[[1]]))
                            row.names(result) <- NULL
                            colnames(result) <- c("Indels", "Frequency", "Location")
                            return(list(fs = res[[2]], indels = result))
                         } 
              })), error = function(e) {print(e); })
        }
        else
        {
             stop("The indel frequency prediction scripts are not found in the extdata directory of CRISPRseek, please update CRISPRseek to the newest version first!") 
        }
   }
   else
   {
       stop("Python 2.7, 3.5 or higher is required for predicting relative indel frequency!")
   }
   setwd(oldDir)
   indelFreq 
}