Update doc for generateGeneBloc() function

KrasnitzLab · Sep 29, 2023 · 82f9a00 · 82f9a00
1 parent e11e68e
commit 82f9a00
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 13 deletions.
diff --git a/R/process1KG_internal.R b/R/process1KG_internal.R
@@ -194,13 +194,19 @@ pruning1KGbyChr <- function(gdsReference, method="corr", listSamples=NULL,
 #'     ## Reference GDS file
 #'     fileReferenceGDS  <- file.path(path1KG, "ex1_good_small_1KG.gds")
 #'
-#'     ## Open the reference GDS file (demo version)
-#'     gds1KG <- snpgdsOpen(fileReferenceGDS)
-#'
-#'     ## The function returns a data frame containing gene block information
-#'     matGeneBlock <- RAIDS:::generateGeneBlock(gdsReference=gds1KG, ensDb=edb)
-#'     print(head(matGeneBlock[grep("ENSG00000157152", matGeneBlock$GName),]))
-#'     closefn.gds(gds1KG)
+#'     \donttest{
+#'         ## Open the reference GDS file (demo version)
+#'         gds1KG <- snpgdsOpen(fileReferenceGDS)
+#'
+#'         ## The function returns a data.frame containing
+#'         ## gene block information
+#'         matGeneBlock <- RAIDS:::generateGeneBlock(gdsReference=gds1KG,
+#'                             ensDb=edb)
+#'         print(head(matGeneBlock[grep("ENSG00000157152",
+#'                             matGeneBlock$GName),]))
+#'
+#'         closefn.gds(gds1KG)
+#'     }
 #' }
 #'
 #' @author Pascal Belleau, Astrid Deschênes and Alex Krasnitz

diff --git a/man/generateGeneBlock.Rd b/man/generateGeneBlock.Rd