Skip to content

Commit

Permalink
added parameters to active percent documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
walterwilliamson committed Oct 9, 2024
1 parent c3a16f6 commit ae92cff
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
4 changes: 4 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ import(ggplot2)
import(patchwork)
import(stats)
importFrom(DT,renderDataTable)
importFrom(lubridate,"%within%")
importFrom(lubridate,days)
importFrom(lubridate,hour)
importFrom(lubridate,interval)
importFrom(lubridate,minute)
importFrom(magrittr,"%>%")
importFrom(utils,tail)
6 changes: 6 additions & 0 deletions R/active_percent.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
#' @inheritParams plot_lasagna
#'
#' @param tz \strong{tz = "".} A character string specifying the time zone to be used. System-specific (see \code{\link{as.POSIXct}}), but " " is the current time zone, and "GMT" is UTC (Universal Time, Coordinated). Invalid values are most commonly treated as UTC, on some platforms with a warning.
#' @param range_type "manual" or "automatic" depending on the desired time interval to be used
#' @param ndays For "manual" calculation, the length of the time interval in days
#' @param end_date For "manual" calculation, the end date of the desired time interval
#'
#' @details
#'The function `active_percent` produces a tibble object with values equal to the
Expand All @@ -21,6 +24,9 @@
#' @return A tibble object with five columns: subject id,
#' corresponding active_percent value, duration of measurement period in days, start date, and end date.
#'
#' @importFrom lubridate days %within% interval
#' @importFrom utils tail
#'
#' @export
#'
#' @author Pratik Patel, Irina Gaynanova
Expand Down
6 changes: 6 additions & 0 deletions man/active_percent.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ae92cff

Please sign in to comment.