Skip to content

Commit 8221657

Browse files
committed
Add patch changes to documentation
1 parent 9c78c07 commit 8221657

3 files changed

Lines changed: 11 additions & 9 deletions

File tree

NEWS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# actverse 0.1.0
44

5-
- 🎉 First release.
5+
- First release. 🎉
66

77
# actverse 0.0.0.9000
88

R/sri.R

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
#' @description
44
#'
55
#' `sri()` computes the Sleep Regularity Index (SRI) as described by Phillips et
6-
#' al. (2017) from a [`tsibble`][tsibble::tsibble()] object, quantifying the
7-
#' consistency of sleep/wake patterns across days.
6+
#' al. ([2017](https://doi.org/10.1038/s41598-017-03171-4)) from a
7+
#' [`tsibble`][tsibble::tsibble()] object, quantifying the consistency of
8+
#' sleep/wake patterns across days.
89
#'
910
#' @details
1011
#'
@@ -27,8 +28,8 @@
2728
#' highly irregular patterns such as alternating 24-hour periods of sleep and
2829
#' wake), such occurrences are extremely rare in practice.
2930
#'
30-
#' See Phillips et al. (2017) to learn more about the SRI and its
31-
#' applications in sleep research.
31+
#' See Phillips et al. ([2017](https://doi.org/10.1038/s41598-017-03171-4)) to
32+
#' learn more about the SRI and its applications in sleep research.
3233
#'
3334
#' @param data A [`tsibble`][tsibble::tsibble()] object.
3435
#' @param state_col (optional) A string indicating which column of `data` have

man/sri.Rd

Lines changed: 5 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)