Browse code

Add missing args in documentation of `.importPyModule()`

Milan Malfait authored on 21/09/2022 13:45:34
Showing 2 changed files

... ...
@@ -18,18 +18,23 @@ SpatialDE.base.tqdm = tqdm.autonotebook.tqdm
18 18
 #' This function loads the SpatialDE Python module and optionally
19 19
 #' monkey-patches it to remove tqdm calls.
20 20
 #'
21
+#' @param proc A process object generated by [`basilisk::basiliskStart()`]
21 22
 #' @param patch_tqdm If `TRUE` patch calls to tqdm.
23
+#' @param set_fake_tqdm
24
+#' @param set_real_tqdm
22 25
 #' @return An R wrapper for the SpatialDE Python module.
23 26
 #'
24 27
 #' @importFrom reticulate import py_run_string
25 28
 #' @importFrom basilisk basiliskRun
29
+#'
30
+#' @keywords internal
26 31
 .importPyModule <- function(proc, patch_tqdm, set_fake_tqdm, set_real_tqdm) {
27 32
   basiliskRun(proc, function(patch_tqdm, set_fake_tqdm, set_real_tqdm, store) {
28 33
     mod <- import("SpatialDE")
29 34
     py_run_string(ifelse(patch_tqdm, set_fake_tqdm, set_real_tqdm))
30
-    
35
+
31 36
     store$spatialDE <- mod
32 37
     invisible(NULL)
33
-  }, patch_tqdm=patch_tqdm, set_fake_tqdm=set_fake_tqdm, 
38
+  }, patch_tqdm=patch_tqdm, set_fake_tqdm=set_fake_tqdm,
34 39
   set_real_tqdm=set_fake_tqdm, persist=TRUE)
35 40
 }
... ...
@@ -7,6 +7,8 @@
7 7
 .importPyModule(proc, patch_tqdm, set_fake_tqdm, set_real_tqdm)
8 8
 }
9 9
 \arguments{
10
+\item{proc}{A process object generated by \code{\link[basilisk:basiliskStart]{basilisk::basiliskStart()}}}
11
+
10 12
 \item{patch_tqdm}{If \code{TRUE} patch calls to tqdm.}
11 13
 }
12 14
 \value{
... ...
@@ -16,3 +18,4 @@ An R wrapper for the SpatialDE Python module.
16 18
 This function loads the SpatialDE Python module and optionally
17 19
 monkey-patches it to remove tqdm calls.
18 20
 }
21
+\keyword{internal}