Skip to content

Commit cc31d9c

Browse files
Revert reporter_previewer doc change from "post-release-cleanup (#247)" (#254)
This reverts the doc change from the commit 78a5aab --------- Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
1 parent ad09cf3 commit cc31d9c

File tree

3 files changed

+35
-41
lines changed

3 files changed

+35
-41
lines changed

R/Previewer.R

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,7 @@
1-
#' Report previewer module
2-
#'
1+
#' Reporter Previewer User Interface
32
#' @description `r lifecycle::badge("experimental")`
4-
#'
5-
#' Module offers functionalities to visualize, manipulate,
6-
#' and interact with report cards that have been added to a report.
7-
#' It includes a previewer interface to see the cards and options to modify the report before downloading.
8-
#'
9-
#' For more details see the vignette: `vignette("previewerReporter", "teal.reporter")`.
10-
#'
11-
#' @details `r global_knitr_details()`
12-
#'
13-
#' @name reporter_previewer
14-
#'
15-
#' @param id (`character(1)`) `shiny` module instance id.
16-
#' @param reporter (`Reporter`) instance.
17-
#' @param global_knitr (`list`) of `knitr` parameters (passed to `knitr::opts_chunk$set`)
18-
#' for customizing the rendering process.
19-
#' @inheritParams reporter_download_inputs
20-
#'
21-
#' @return `NULL`.
22-
NULL
23-
24-
#' @rdname reporter_previewer
3+
#' reporter previewer user interface to visualize and manipulate the already added report Cards
4+
#' @param id `character(1)` this `shiny` module's id.
255
#' @export
266
reporter_previewer_ui <- function(id) {
277
ns <- shiny::NS(id)
@@ -45,7 +25,17 @@ reporter_previewer_ui <- function(id) {
4525
)
4626
}
4727

48-
#' @rdname reporter_previewer
28+
#' Reporter Previewer Server
29+
#' @description `r lifecycle::badge("experimental")`
30+
#' server supporting the functionalities of the reporter previewer
31+
#' For more details see the vignette: `vignette("previewerReporter", "teal.reporter")`.
32+
#' @param id `character(1)` this `shiny` module's id.
33+
#' @param reporter `Reporter` instance
34+
#' @param global_knitr `list` a of `knitr` parameters (passed to `knitr::opts_chunk$set`)
35+
#' for customizing the rendering process.
36+
#' @inheritParams reporter_download_inputs
37+
#' @details `r global_knitr_details()`
38+
#'
4939
#' @export
5040
reporter_previewer_srv <- function(id,
5141
reporter,

man/reporter_previewer.Rd renamed to man/reporter_previewer_srv.Rd

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

man/reporter_previewer_ui.Rd

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

0 commit comments

Comments
 (0)