Browse code

Updated doc

fortinj2 authored on 22/07/2022 15:43:22
Showing 3 changed files

... ...
@@ -388,6 +388,22 @@ mrnaSequence <- Biostrings::readDNAStringSet(filepath=fasta
388 388
 results <- getCasRxRFScores(mrnaSequence)
389 389
 ```
390 390
 
391
+Note that the function has a default argument `directRepeat` set to `aacccctaccaactggtcggggtttgaaac`, specifying the direct repeat used in the
392
+CasRx construct (see [@casrxrf].) The function also has an argument `binaries`
393
+that specifies the file path of the binaries for three 
394
+programs necessary by the CasRxRF algorithm:
395
+
396
+- `RNAfold`: available as part of the ViennaRNA package
397
+- `RNAplfold`: available as part of the ViennaRNA package
398
+- `RNAhybrid`: available as part of the RNAhybrid package
399
+
400
+Those programs can be installed from their respective websites: [VienneRNA](https://www.tbi.univie.ac.at/RNA/) and [RNAhybrid](https://bibiserv.cebitec.uni-bielefeld.de/rnahybrid/).
401
+
402
+If the argument is `NULL`, the binaries are assumed to be available on
403
+the PATH. 
404
+
405
+
406
+
391 407
 
392 408
 # Off-target specificity scores 
393 409
 
... ...
@@ -438,6 +438,23 @@ mrnaSequence <- Biostrings::readDNAStringSet(filepath=fasta
438 438
 results <- getCasRxRFScores(mrnaSequence)
439 439
 ```
440 440
 
441
+Note that the function has a default argument `directRepeat` set to
442
+`aacccctaccaactggtcggggtttgaaac`, specifying the direct repeat used in
443
+the CasRx construct (see (Wessels et al. 2020).) The function also has
444
+an argument `binaries` that specifies the file path of the binaries for
445
+three programs necessary by the CasRxRF algorithm:
446
+
447
+-   `RNAfold`: available as part of the ViennaRNA package
448
+-   `RNAplfold`: available as part of the ViennaRNA package
449
+-   `RNAhybrid`: available as part of the RNAhybrid package
450
+
451
+Those programs can be installed from their respective websites:
452
+[VienneRNA](https://www.tbi.univie.ac.at/RNA/) and
453
+[RNAhybrid](https://bibiserv.cebitec.uni-bielefeld.de/rnahybrid/).
454
+
455
+If the argument is `NULL`, the binaries are assumed to be available on
456
+the PATH.
457
+
441 458
 # Off-target specificity scores
442 459
 
443 460
 For CRISPR knockout systems, off-targeting effects can occur when the
... ...
@@ -611,7 +628,7 @@ sessionInfo()
611 628
     ## [1] stats     graphics  grDevices utils     datasets  methods   base     
612 629
     ## 
613 630
     ## other attached packages:
614
-    ## [1] crisprScore_1.1.6     crisprScoreData_1.1.3 ExperimentHub_2.3.5  
631
+    ## [1] crisprScore_1.1.9     crisprScoreData_1.1.3 ExperimentHub_2.3.5  
615 632
     ## [4] AnnotationHub_3.3.9   BiocFileCache_2.3.4   dbplyr_2.1.1         
616 633
     ## [7] BiocGenerics_0.41.2  
617 634
     ## 
... ...
@@ -624,7 +641,7 @@ sessionInfo()
624 641
     ## [11] GenomeInfoDb_1.31.6           stats4_4.2.0                 
625 642
     ## [13] RSQLite_2.2.12                evaluate_0.15                
626 643
     ## [15] highr_0.9                     httr_1.4.2                   
627
-    ## [17] pillar_1.7.0                  basilisk_1.9.1               
644
+    ## [17] pillar_1.7.0                  basilisk_1.9.2               
628 645
     ## [19] zlibbioc_1.41.0               rlang_1.0.2                  
629 646
     ## [21] curl_4.3.2                    rstudioapi_0.13              
630 647
     ## [23] blob_1.2.2                    S4Vectors_0.33.11            
... ...
@@ -639,7 +656,7 @@ sessionInfo()
639 656
     ## [41] interactiveDisplayBase_1.33.0 IRanges_2.29.1               
640 657
     ## [43] randomForest_4.7-1            fansi_1.0.2                  
641 658
     ## [45] crayon_1.5.0                  dplyr_1.0.8                  
642
-    ## [47] later_1.3.0                   basilisk.utils_1.5.0         
659
+    ## [47] later_1.3.0                   basilisk.utils_1.9.1         
643 660
     ## [49] bitops_1.0-7                  rappdirs_0.3.3               
644 661
     ## [51] grid_4.2.0                    jsonlite_1.8.0               
645 662
     ## [53] xtable_1.8-4                  lifecycle_1.0.1              
... ...
@@ -402,6 +402,21 @@ results <- getCasRxRFScores(mrnaSequence)
402 402
 ```
403 403
 
404 404
 
405
+Note that the function has a default argument `directRepeat` set to `aacccctaccaactggtcggggtttgaaac`, specifying the direct repeat used in the
406
+CasRx construct (see [@casrxrf].) The function also has an argument `binaries`
407
+that specifies the file path of the binaries for three 
408
+programs necessary by the CasRxRF algorithm:
409
+
410
+- `RNAfold`: available as part of the ViennaRNA package
411
+- `RNAplfold`: available as part of the ViennaRNA package
412
+- `RNAhybrid`: available as part of the RNAhybrid package
413
+
414
+Those programs can be installed from their respective websites: [VienneRNA](https://www.tbi.univie.ac.at/RNA/) and [RNAhybrid](https://bibiserv.cebitec.uni-bielefeld.de/rnahybrid/).
415
+
416
+If the argument is `NULL`, the binaries are assumed to be available on
417
+the PATH. 
418
+
419
+
405 420
 # Off-target specificity scores 
406 421
 
407 422
 For CRISPR knockout systems, off-targeting effects can occur when the CRISPR