Skip to content

Commit a5a8139

Browse files
Jfortin1Jfortin1
committed
Updated vignette
1 parent bdb0f7e commit a5a8139

File tree

4 files changed

+47
-34
lines changed

4 files changed

+47
-34
lines changed

‎DESCRIPTION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: crisprViz
22
Title: Visualization Functions for CRISPR gRNAs
3-
Version: 0.99.22
3+
Version: 0.99.23
44
Authors@R: c(
55
person("Jean-Philippe", "Fortin", email = "fortin946@gmail.com", role = c("aut", "cre")),
66
person("Luke", "Hoberecht", email = "lukehob3@gmail.com", role = c("aut"))

‎README.Rmd‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,17 @@ knitr::opts_chunk$set(message=FALSE, warning=FALSE)
1717

1818
# Introduction
1919

20-
The `crisprViz` package enables the graphical interpretation of `GuideSet` objects from the `crisprDesign` package by plotting guide RNA (gRNA) cutting locations against their target gene or other genomic region. These genomic plots are constructed using the `Gviz` package from Bioconductor.
20+
The `crisprViz` package enables the graphical interpretation of `GuideSet`
21+
objects from the [crisprDesign](https://github.com/crisprVerse/crisprDesign) package by plotting guide RNA (gRNA)
22+
cutting locations against their target gene or other genomic region.
23+
24+
This vignette walks through several use cases that demonstrate the range of
25+
and how to use plotting functions in the `crisprViz` package. This vignette
26+
also uses our core gRNA design package [crisprDesign](https://github.com/crisprVerse/crisprDesign)to manipulate `GuideSet` objects in
27+
conjunction with plotting in the process of gRNA design.
28+
29+
Visit our [crisprVerse tutorial page](https://github.com/crisprVerse/Tutorials) to learn more about how to design gRNAs for different applications.
2130

22-
This vignette walks through several use cases that demonstrate the range of and how to use plotting functions in the `crisprViz` package. This vignette also makes heavy use of the `crisprDesign` package to manipulate `GuideSet` objects in conjunction with plotting in the process of gRNA design. For more information about the `crisprDesign` package see [vignettes].
2331

2432
# Installation and getting started
2533

‎README.md‎

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,21 @@ Date: July 24, 2022
3535
# Introduction
3636

3737
The `crisprViz` package enables the graphical interpretation of
38-
`GuideSet` objects from the `crisprDesign` package by plotting guide RNA
39-
(gRNA) cutting locations against their target gene or other genomic
40-
region. These genomic plots are constructed using the `Gviz` package
41-
from Bioconductor.
38+
`GuideSet` objects from the
39+
[crisprDesign](https://github.com/crisprVerse/crisprDesign) package by
40+
plotting guide RNA (gRNA) cutting locations against their target gene or
41+
other genomic region.
4242

4343
This vignette walks through several use cases that demonstrate the range
4444
of and how to use plotting functions in the `crisprViz` package. This
45-
vignette also makes heavy use of the `crisprDesign` package to
46-
manipulate `GuideSet` objects in conjunction with plotting in the
47-
process of gRNA design. For more information about the `crisprDesign`
48-
package see \[vignettes\].
45+
vignette also uses our core gRNA design package
46+
[crisprDesign](https://github.com/crisprVerse/crisprDesign)to manipulate
47+
`GuideSet` objects in conjunction with plotting in the process of gRNA
48+
design.
49+
50+
Visit our [crisprVerse tutorial
51+
page](https://github.com/crisprVerse/Tutorials) to learn more about how
52+
to design gRNAs for different applications.
4953

5054
# Installation and getting started
5155

@@ -492,20 +496,20 @@ sessionInfo()
492496
## [8] base
493497
##
494498
## other attached packages:
495-
## [1] crisprViz_0.99.18 crisprDesign_0.99.134
496-
## [3] crisprBase_1.1.5 BSgenome.Hsapiens.UCSC.hg38_1.4.4
499+
## [1] crisprViz_0.99.22 crisprDesign_0.99.176
500+
## [3] crisprBase_1.1.8 BSgenome.Hsapiens.UCSC.hg38_1.4.4
497501
## [5] BSgenome_1.65.2 rtracklayer_1.57.0
498-
## [7] Biostrings_2.65.2 XVector_0.37.0
499-
## [9] GenomicRanges_1.49.1 GenomeInfoDb_1.33.5
500-
## [11] IRanges_2.31.2 S4Vectors_0.35.1
501-
## [13] BiocGenerics_0.43.1
502+
## [7] Biostrings_2.65.3 XVector_0.37.1
503+
## [9] GenomicRanges_1.49.1 GenomeInfoDb_1.33.7
504+
## [11] IRanges_2.31.2 S4Vectors_0.35.3
505+
## [13] BiocGenerics_0.43.4
502506
##
503507
## loaded via a namespace (and not attached):
504508
## [1] backports_1.4.1 Hmisc_4.7-1
505-
## [3] AnnotationHub_3.5.0 BiocFileCache_2.5.0
509+
## [3] AnnotationHub_3.5.1 BiocFileCache_2.5.0
506510
## [5] lazyeval_0.2.2 splines_4.2.1
507511
## [7] BiocParallel_1.31.12 ggplot2_3.3.6
508-
## [9] digest_0.6.29 ensembldb_2.21.3
512+
## [9] digest_0.6.29 ensembldb_2.21.4
509513
## [11] htmltools_0.5.3 fansi_1.0.3
510514
## [13] checkmate_2.1.0 magrittr_2.0.3
511515
## [15] memoise_2.0.1 cluster_2.1.4
@@ -514,27 +518,27 @@ sessionInfo()
514518
## [21] jpeg_0.1-9 colorspace_2.0-3
515519
## [23] blob_1.2.3 rappdirs_0.3.3
516520
## [25] crisprScoreData_1.1.3 xfun_0.32
517-
## [27] dplyr_1.0.9 crayon_1.5.1
521+
## [27] dplyr_1.0.10 crayon_1.5.1
518522
## [29] RCurl_1.98-1.8 jsonlite_1.8.0
519523
## [31] survival_3.4-0 VariantAnnotation_1.43.3
520-
## [33] glue_1.6.2 gtable_0.3.0
524+
## [33] glue_1.6.2 gtable_0.3.1
521525
## [35] zlibbioc_1.43.0 DelayedArray_0.23.1
522526
## [37] scales_1.2.1 DBI_1.1.3
523527
## [39] Rcpp_1.0.9 htmlTable_2.4.1
524528
## [41] xtable_1.8-4 progress_1.2.2
525-
## [43] reticulate_1.25 foreign_0.8-82
529+
## [43] reticulate_1.26 foreign_0.8-82
526530
## [45] bit_4.0.4 Formula_1.2-4
527531
## [47] htmlwidgets_1.5.4 httr_1.4.4
528-
## [49] dir.expiry_1.5.0 RColorBrewer_1.1-3
532+
## [49] dir.expiry_1.5.1 RColorBrewer_1.1-3
529533
## [51] ellipsis_0.3.2 pkgconfig_2.0.3
530534
## [53] XML_3.99-0.10 Gviz_1.41.1
531535
## [55] nnet_7.3-17 dbplyr_2.2.1
532536
## [57] deldir_1.0-6 utf8_1.2.2
533-
## [59] tidyselect_1.1.2 rlang_1.0.4
537+
## [59] tidyselect_1.1.2 rlang_1.0.5
534538
## [61] later_1.3.0 AnnotationDbi_1.59.1
535539
## [63] munsell_0.5.0 BiocVersion_3.16.0
536540
## [65] tools_4.2.1 cachem_1.0.6
537-
## [67] cli_3.3.0 generics_0.1.3
541+
## [67] cli_3.4.0 generics_0.1.3
538542
## [69] RSQLite_2.2.16 ExperimentHub_2.5.0
539543
## [71] evaluate_0.16 stringr_1.4.1
540544
## [73] fastmap_1.1.0 yaml_2.3.5
@@ -547,8 +551,8 @@ sessionInfo()
547551
## [87] filelock_1.0.2 curl_4.3.2
548552
## [89] png_0.1-7 interactiveDisplayBase_1.35.0
549553
## [91] tibble_3.1.8 stringi_1.7.8
550-
## [93] crisprScore_1.1.14 highr_0.9
551-
## [95] basilisk.utils_1.9.1 GenomicFeatures_1.49.6
554+
## [93] crisprScore_1.1.15 highr_0.9
555+
## [95] basilisk.utils_1.9.3 GenomicFeatures_1.49.6
552556
## [97] lattice_0.20-45 ProtGenerics_1.29.0
553557
## [99] Matrix_1.4-1 vctrs_0.4.1
554558
## [101] pillar_1.8.1 lifecycle_1.0.1
@@ -558,12 +562,12 @@ sessionInfo()
558562
## [109] latticeExtra_0.6-30 promises_1.2.0.1
559563
## [111] gridExtra_2.3 codetools_0.2-18
560564
## [113] dichromat_2.0-0.1 crisprBowtie_1.1.1
561-
## [115] assertthat_0.2.1 SummarizedExperiment_1.27.1
565+
## [115] assertthat_0.2.1 SummarizedExperiment_1.27.2
562566
## [117] rjson_0.2.21 GenomicAlignments_1.33.1
563567
## [119] Rsamtools_2.13.4 GenomeInfoDbData_1.2.8
564568
## [121] parallel_4.2.1 hms_1.1.2
565569
## [123] rpart_4.1.16 grid_4.2.1
566-
## [125] basilisk_1.9.2 rmarkdown_2.15.2
570+
## [125] basilisk_1.9.6 rmarkdown_2.16
567571
## [127] MatrixGenerics_1.9.1 biovizBase_1.45.0
568572
## [129] Biobase_2.57.1 shiny_1.7.2
569573
## [131] base64enc_0.1-3 interp_1.1-3

‎vignettes/intro.Rmd‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,16 @@ knitr::opts_chunk$set(message=FALSE, warning=FALSE)
2424
# Introduction
2525

2626
The `crisprViz` package enables the graphical interpretation of `GuideSet`
27-
objects from the `crisprDesign` package by plotting guide RNA (gRNA)
27+
objects from the [crisprDesign](https://github.com/crisprVerse/crisprDesign) package by plotting guide RNA (gRNA)
2828
cutting locations against their target gene or other genomic region.
29-
These genomic plots are constructed using the `Gviz` package from Bioconductor.
3029

3130
This vignette walks through several use cases that demonstrate the range of
3231
and how to use plotting functions in the `crisprViz` package. This vignette
33-
also uses the `crisprDesign` package to manipulate `GuideSet` objects in
34-
conjunction with plotting in the process of gRNA design. For more information
35-
about the `crisprDesign` package see [vignettes].
32+
also uses our core gRNA design package [crisprDesign](https://github.com/crisprVerse/crisprDesign)to manipulate `GuideSet` objects in
33+
conjunction with plotting in the process of gRNA design.
34+
35+
Visit our [crisprVerse tutorial page](https://github.com/crisprVerse/Tutorials) to learn more about how to design gRNAs for different applications.
36+
3637

3738
# Installation and getting started
3839

0 commit comments

Comments
 (0)