fixed documentation notes

tanaylab · Nov 29, 2023 · 6890763 · 6890763
1 parent f5df51e
commit 6890763
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 12 deletions.
diff --git a/R/extract.R b/R/extract.R
@@ -202,7 +202,7 @@ emr_dist <- function(..., include.lowest = FALSE, right = TRUE, stime = NULL, et
 #' @section iterator:
 #'
 #' There are a few types of iterators:
-#' \itemize{
+#' \describe{
 #'  \item{Track iterator: }{Track iterator returns the points (including the reference) from the specified track. Track name is specified as a string. If `keepref=FALSE` the reference of each point is set to `-1` \cr
 #' Example: \cr \cr
 #' # Returns the level of glucose one hour after the insulin shot was made \cr
@@ -260,6 +260,7 @@ emr_dist <- function(..., include.lowest = FALSE, right = TRUE, stime = NULL, et
 #' \item{Implicit Iterator: }{The iterator is set implicitly if its value remains `NULL` (which is the default). In that case the track expression is analyzed and searched for track names. If all the track variables or virtual track variables point to the same track, this track is used as a source for a track iterator. If more then one track appears in the track expression, an error message is printed out notifying ambiguity.}
 #' }
 #'
+#'
 #' Revealing Current Iterator Time:
 #' During the evaluation of a track expression one can access a specially defined variable named `EMR_TIME` (Python: `TIME`). This variable contains a vector (`numpy.ndarray` in Python) of current iterator times. The length of the vector matches the length of the track variable (which is a vector too). \cr
 #' Note that some values in `EMR_TIME` might be set 0. Skip those intervals and the values of the track variables at the corresponding indices. \cr

diff --git a/R/filter.R b/R/filter.R
@@ -231,7 +231,7 @@
 #' Generate a default name for a naryn filter
 #'
 #' Given filter parameters, generate a name with the following format:
-#' "f_{src}.kr{keepref}.vals_{val}.ts_{time.shift}.exp_{expiration}.op_{operator}"
+#' "f_(src).kr(keepref).vals_(val).ts_(time.shift).exp_(expiration).op_(operator)"
 #' Where for 'val' and 'time.shift' the values are separated by an
 #' underscore.
 #'

diff --git a/R/vtrack.R b/R/vtrack.R
@@ -85,7 +85,7 @@
 #' Generate a default name for a virtual track
 #'
 #' Given virtual track parameters, generate a name with the following format:
-#' "vt_{src}.func_{func}.params_{params}.kr{keepref}.ts_{time.shift}.id_{id.map}.filter_{filter}"
+#' "vt_(src).func_(func).params_(params).kr(keepref).ts_(time.shift).id_(id.map).filter_(filter)"
 #' Where for 'params', 'time.shift', and 'id.map', the values are separated by an
 #' underscore.
 #'

diff --git a/man/emr_cor.Rd b/man/emr_cor.Rd
diff --git a/man/emr_dist.Rd b/man/emr_dist.Rd
diff --git a/man/emr_extract.Rd b/man/emr_extract.Rd
diff --git a/man/emr_filter.name.Rd b/man/emr_filter.name.Rd
diff --git a/man/emr_quantiles.Rd b/man/emr_quantiles.Rd
diff --git a/man/emr_screen.Rd b/man/emr_screen.Rd
diff --git a/man/emr_summary.Rd b/man/emr_summary.Rd
diff --git a/man/emr_track.create.Rd b/man/emr_track.create.Rd
diff --git a/man/emr_vtrack.name.Rd b/man/emr_vtrack.name.Rd