fix: add dontrun{} to examples to satistfy CRAN NOTE

ainefairbrother · May 19, 2023 · 55eb415 · 55eb415
1 parent 6c3d71c
commit 55eb415
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,4 @@ ensemblQueryR.Rproj
 .rprof.log
 rprof.log
 CRAN-SUBMISSION
+cran-commends.md
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -18,6 +18,7 @@ Imports:
     rlang,
     tibble,
     tidyr,
+    utils,
     vroom,
     xml2
 Suggests: 

diff --git a/R/ensemblQueryLDregionEndpoint.R b/R/ensemblQueryLDregionEndpoint.R
@@ -136,6 +136,7 @@ ensemblQueryLDwithSNPregion = function(chr, start, end, pop="1000GENOMES:phase_3
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' library(magrittr)
 #'
 #' data.frame(
@@ -148,7 +149,7 @@ ensemblQueryLDwithSNPregion = function(chr, start, end, pop="1000GENOMES:phase_3
 #'     pop="1000GENOMES:phase_3:EUR",
 #'     cores = 1
 #'   )
-#'
+#'}
 ensemblQueryLDwithSNPregionDataframe = function(in.table, pop="1000GENOMES:phase_3:EUR", cores=1){
 
   # # Test

diff --git a/R/ensemblQueryLDwindowEndpoint.R b/R/ensemblQueryLDwindowEndpoint.R
@@ -135,6 +135,7 @@ ensemblQueryLDwithSNPwindow = function(rsid, pop="1000GENOMES:phase_3:EUR", r2=N
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' in.table = data.frame(rsid = rep(c("rs7153434","rs1963154","rs12672022",
 #'                                    "rs3852802","rs12324408","rs56346870"), 5))
 #'
@@ -144,7 +145,7 @@ ensemblQueryLDwithSNPwindow = function(rsid, pop="1000GENOMES:phase_3:EUR", r2=N
 #'                                      d.prime=0.8,
 #'                                      window.size=500,
 #'                                      cores=1)
-#'
+#'}
 ensemblQueryLDwithSNPwindowDataframe = function(in.table, pop="1000GENOMES:phase_3:EUR", r2=NA, d.prime=NA, window.size=NA, cores=1){
 
   #------------------------------ test -------------------------------

diff --git a/R/globals.R b/R/globals.R
@@ -0,0 +1,6 @@
+library(utils)
+
+utils::globalVariables(c("variation1", "variation2", "query1",
+                         "query2", "r2", "d_prime", "population_name",
+                         ".", "query_chr", "query_start", "query_end",
+                         "rsid1", "rsid2", "snp_in_ld", "query"))
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,6 +18,7 @@ Imports: @@
         rlang,
         tibble,
         tidyr,
+        utils,
         vroom,
         xml2
     Suggests:
@@ Expand Down @@