Browse code

Readu to merge

fortinj2 authored on 29/06/2022 21:08:58
Showing 2 changed files

... ...
@@ -4,6 +4,8 @@
4 4
 #' 
5 5
 #' @param sequences Character vector of 30bp sequences needed for DeepSpCas9
6 6
 #'     scoring, see details below.
7
+#' @param fork Set to \code{TRUE} to preserve changes to the R
8
+#'     configuration within the session.
7 9
 #' 
8 10
 #' @details The input sequences for DeepSpCas9 scoring require 4 nucleotides
9 11
 #'     upstream of the protospacer sequence, the protospacer sequence
... ...
@@ -15,7 +17,7 @@
15 17
 #'     takes on a value between 0 and 1. A higher score indicates higher
16 18
 #'     knockout efficiency.
17 19
 #' 
18
-#' @reference
20
+#' @references
19 21
 #' Kim HK, Kim Y, Lee S, et al. SpCas9 activity prediction by DeepSpCas9, 
20 22
 #'     a deep learning–base model with high generalization performance.
21 23
 #'     Science advances. 2019 Nov 6;5(11):eaax9249.
... ...
@@ -31,7 +33,6 @@
31 33
 #' input  <- paste0(flank5, spacer, pam, flank3) 
32 34
 #' results <- getDeepSpCas9Scores(input)
33 35
 #' }
34
-#' 
35 36
 #' @export 
36 37
 #' @importFrom basilisk basiliskStart basiliskStop basiliskRun
37 38
 getDeepSpCas9Scores <- function(sequences,
... ...
@@ -9,6 +9,9 @@ getDeepSpCas9Scores(sequences, fork = FALSE)
9 9
 \arguments{
10 10
 \item{sequences}{Character vector of 30bp sequences needed for DeepSpCas9
11 11
 scoring, see details below.}
12
+
13
+\item{fork}{Set to \code{TRUE} to preserve changes to the R
14
+configuration within the session.}
12 15
 }
13 16
 \value{
14 17
 \strong{getDeepSpCas9Scores} returns a data.frame with
... ...
@@ -35,7 +38,11 @@ flank3 <- "AAT" #3bp
35 38
 input  <- paste0(flank5, spacer, pam, flank3) 
36 39
 results <- getDeepSpCas9Scores(input)
37 40
 }
38
-
41
+}
42
+\references{
43
+Kim HK, Kim Y, Lee S, et al. SpCas9 activity prediction by DeepSpCas9, 
44
+    a deep learning–base model with high generalization performance.
45
+    Science advances. 2019 Nov 6;5(11):eaax9249.
39 46
 }
40 47
 \author{
41 48
 Jean-Philippe Fortin