Skip to content

Commit 226ba49

Browse files
committed
fix: doc missing arg, fix vignette
1 parent 03cf6e3 commit 226ba49

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

R/revision_analysis.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@
6565
#' requested signal. The default is `TRUE`.
6666
#' @param compactify_abs_tol length-1 double, used if `compactify` is `TRUE`, it
6767
#' determines the threshold for when two doubles are considered identical.
68+
#' @param return_only_tibble boolean to return only the simple `tibble` of
69+
#' computational results rather than the complete S3 object.
6870
#'
6971
#' @details Applies to `epi_archive`s with `time_type`s of `"day"`, `"week"`,
7072
#' and `"yearmonth"`. It can also work with a `time_type` of `"integer"` if

man/revision_analysis.Rd

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

vignettes/epi_archive.Rmd

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,8 @@ addition to the per key summary, it also returns an overall summary. Here is an
162162
a sample of the output:
163163

164164
```{r}
165-
revision_details <- revision_summary(dv_archive, print_inform = TRUE)
165+
revision_details <- revision_summary(dv_archive)
166+
revision_details
166167
```
167168

168169
We can see from the output that, as mentioned above, this data set has a lot of
@@ -174,9 +175,9 @@ inspect the returned `revision_details` tibble. Here we collect a number of
174175
statistics for each state:
175176

176177
```{r}
177-
revision_details %>%
178+
revision_details$revision_behavior %>%
178179
group_by(geo_value) %>%
179-
summarise(
180+
summarize(
180181
n_rev = mean(n_revisions),
181182
min_lag = min(min_lag),
182183
max_lag = max(max_lag),

0 commit comments

Comments
 (0)