updated documentation bugs

irinagain · Jan 23, 2024 · ebac297 · ebac297
1 parent 7c28f72
commit ebac297
Show file tree

Hide file tree

Showing 13 changed files with 20 additions and 20 deletions.
diff --git a/R/mage_ma_single.R b/R/mage_ma_single.R
@@ -8,9 +8,9 @@
 #' @inheritParams CGMS2DayByDay
 #' @param short_ma Integer for period length of the short moving average. Must be positive and less than "long_ma", default value is 5. (Recommended <15)
 #' @param long_ma Integer for period length for the long moving average, default value is 32. (Recommended >20)
-#' @param return_type One of "num" and "df": will return a single value for MAGE or a DataFrame with the
-#' @param direction One of 'avg', 'service', 'max', 'plus', or 'minus'. (Default: "avg"). Algorithm will either calculate MAGE+ (nadir to peak), MAGE- (peak to nadir), MAGEavg = avg(MAGE+, MAGE-), MAGEmax = max(MAGE+, MAGE-), or automatically choose MAGE+/MAGE- based on the first countable excursion (i.e., "service").
-#' @param plot Boolean. Returns ggplot if TRUE.
+#' @param return_type One of "num" or "df": will return a single value for MAGE over the entire trace (weighted by segment length) or a DataFrame with the MAGE value for each segment (see the MAGE vignette for discussion of handling gaps by splitting trace into multiple segments).
+#' @param direction One of 'avg', 'service', 'max', 'plus', or 'minus'. (Default: "avg"). Algorithm will either calculate MAGE+ (nadir to peak), MAGE- (peak to nadir), MAGEavg = avg(MAGE+, MAGE-), MAGEmax = max(MAGE+, MAGE-), or automatically choose MAGE+/MAGE- based on the first countable excursion (i.e., "service"). NOTE: selection used independently on each segments, thus MAGEservice may choose MAGE+ on one segment and MAGE- on another.
+#' @param plot Boolean. Returns ggplot by default if TRUE.
 #' @param max_gap The maximum length of a gap before MAGE is calculated on each segment independently (recommended: 180 minutes)
 #' @param title Title for the ggplot. Defaults to "Glucose Trace - Subject [ID]"
 #' @param xlab Label for x-axis of ggplot. Defaults to "Time"

diff --git a/R/utils.R b/R/utils.R
@@ -104,7 +104,7 @@ read_df_or_vec <- function(data, id = 'id', time = 'time', gl = 'gl'){
 #' Interpolate glucose value on an equally spaced grid from day to day
 #'
 #' @inheritParams conga
-#' @param data DataFrame object with column names "id", "time", and "gl". Should only be data for 1 subject. In case multiple subject ids are detected, the warning is produced and only 1st subject is used.
+#' @param data DataFrame object with column names "id", "time", and "gl". Should only be data for 1 subject. In case multiple subject ids are detected, a warning is produced and only 1st subject is used.
 #' @param dt0 The time frequency for interpolation in minutes, the default will match the CGM meter's frequency (e.g. 5 min for Dexcom).
 #' @param inter_gap The maximum allowable gap (in minutes) for interpolation. The values will not be interpolated between the glucose measurements that are more than inter_gap minutes apart. The default value is 45 min.
 #'

diff --git a/man/CGMS2DayByDay.Rd b/man/CGMS2DayByDay.Rd
diff --git a/man/agp.Rd b/man/agp.Rd
diff --git a/man/cv_measures.Rd b/man/cv_measures.Rd
diff --git a/man/epicalc_profile.Rd b/man/epicalc_profile.Rd
diff --git a/man/episode_calculation.Rd b/man/episode_calculation.Rd
diff --git a/man/mage.Rd b/man/mage.Rd
diff --git a/man/mage_ma_single.Rd b/man/mage_ma_single.Rd
diff --git a/man/meal_metrics.Rd b/man/meal_metrics.Rd
diff --git a/man/pgs.Rd b/man/pgs.Rd
diff --git a/man/plot_agp.Rd b/man/plot_agp.Rd
diff --git a/man/plot_ranges.Rd b/man/plot_ranges.Rd