Skip to content

Commit

Permalink
removing backtics from functions.
Browse files Browse the repository at this point in the history
  • Loading branch information
kartikeyakirar committed Jan 29, 2024
1 parent a6b7638 commit a6b98fe
Show file tree
Hide file tree
Showing 21 changed files with 34 additions and 38 deletions.
2 changes: 1 addition & 1 deletion R/dummy_functions.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#' `r lifecycle::badge("experimental")`
#'
#' @inheritParams module
#' @return A `teal` module which can be included in the `modules` argument to [`teal::init()`].
#' @return A `teal` module which can be included in the `modules` argument to [init()].
#' @examples
#' app <- init(
#' data = teal_data(IRIS = iris, MTCARS = mtcars),
Expand Down
7 changes: 3 additions & 4 deletions R/init.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,19 @@
#' defaults from the `teal_data` environment will be used.
#'
#' @param data (`teal_data` or `teal_data_module`)
#' `teal_data` object as returned by [`teal.data::teal_data()`] or `teal_data_module`.
#' @param modules (`list` or `teal_modules` or `teal_module`)
#' nested list of `teal_modules` or `teal_module` objects or a single
#' `teal_modules` or `teal_module` object. These are the specific output modules which
#' will be displayed in the `teal` application. See [`modules()`] and [`module()`] for
#' will be displayed in the `teal` application. See [modules()] and [module()] for
#' more details.
#' @param title (`shiny.tag` or `character(1)`)
#' The browser window title. Defaults to a title "teal app" with the icon of NEST.
#' Can be created using the `build_app_title()` or
#' by passing a valid `shiny.tag` which is a head tag with title and link tag.
#' @param filter (`teal_slices`)
#' Specification of initial filter. Filters can be specified using [`teal::teal_slices()`].
#' Specification of initial filter. Filters can be specified using [teal::teal_slices()].
#' Old way of specifying filters through a list is deprecated and will be removed in the
#' next release. Please fix your applications to use [`teal::teal_slices()`].
#' next release. Please fix your applications to use [teal::teal_slices()].
#' @param header (`shiny.tag` or `character(1)`)
#' The header of the app.
#' @param footer (`shiny.tag` or `character(1)`)
Expand Down
4 changes: 2 additions & 2 deletions R/module_snapshot_manager.R
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
#' The snapshot contains the `mapping` attribute of the initial application state
#' (or one that has been restored), which may not reflect the current one,
#' so `mapping_matrix` is transformed to obtain the current mapping, i.e. a list that,
#' when passed to the `mapping` argument of [`teal::teal_slices`], would result in the current mapping.
#' when passed to the `mapping` argument of [teal_slices()], would result in the current mapping.
#' This is substituted as the snapshot's `mapping` attribute and the snapshot is added to the snapshot list.
#'
#' To restore app state, a snapshot is retrieved from storage and rebuilt into a `teal_slices` object.
Expand All @@ -49,7 +49,7 @@
#' The snapshot is then set as the current content of `slices_global`.
#'
#' To save a snapshot, the snapshot is retrieved and reassembled just like for restoring,
#' and then saved to file with [`slices_store`].
#' and then saved to file with [slices_store()].
#'
#' When a snapshot is uploaded, it will first be added to storage just like a newly created one,
#' and then used to restore app state much like a snapshot taken from storage.
Expand Down
6 changes: 3 additions & 3 deletions R/modules.R
Original file line number Diff line number Diff line change
Expand Up @@ -173,10 +173,10 @@ is_arg_used <- function(modules, arg) {
#' This function embeds a `shiny` module inside a `teal` application. One `teal_module` maps to one `shiny` module.
#'
#' @param label (`character(1)`) Label shown in the navigation item for the module. Any label possible except
#' `"global_filters"` - read more in `mapping` argument of [`teal::teal_slices`].
#' `"global_filters"` - read more in `mapping` argument of [teal_slices()].
#' @param server (`function`) `shiny` module with following arguments:
#' - `id` - `teal` will set proper `shiny` namespace for this module (see [`shiny::moduleServer()`]).
#' - `input`, `output`, `session` - (not recommended) then [`shiny::callModule()`] will be used to call a module.
#' - `id` - `teal` will set proper `shiny` namespace for this module (see [shiny::moduleServer()]).
#' - `input`, `output`, `session` - (not recommended) then [shiny::callModule()] will be used to call a module.
#' - `data` (optional) module will receive a `teal_data` object, a list of reactive (filtered) data specified in
#' the `filters` argument.
#' - `datasets` (optional) module will receive `FilteredData`. (See [`teal.slice::FilteredData`]).
Expand Down
2 changes: 1 addition & 1 deletion R/modules_debugging.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#' Dummy module to show the filter calls generated by the right encoding panel
#'
#' Please do not remove, this is useful for debugging `teal` without
#' dependencies and simplifies [`devtools::load_all`] which otherwise fails
#' dependencies and simplifies [devtools::load_all()] which otherwise fails
#' and avoids session restarts!
#'
#' @param label `character` label of module
Expand Down
8 changes: 4 additions & 4 deletions R/reporter_previewer_module.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
#'
#' @description `r lifecycle::badge("experimental")`
#'
#' This function wraps [`teal.reporter::reporter_previewer_ui()`] and
#' [`teal.reporter::reporter_previewer_srv()`] into a `teal_module` to be
#' This function wraps [teal.reporter::reporter_previewer_ui()] and
#' [teal.reporter::reporter_previewer_srv()] into a `teal_module` to be
#' used in `teal` applications.
#'
#' If you are creating a `teal` application using [`teal::init()`] then this
#' If you are creating a `teal` application using [init()] then this
#' module will be added to your application automatically if any of your `teal modules`
#' support report generation.
#'
#' @inheritParams module
#' @param server_args (named `list`)
#' Arguments passed to [`teal.reporter::reporter_previewer_srv()`].
#' Arguments passed to [teal.reporter::reporter_previewer_srv()].
#' @return `teal_module` (extended with `teal_module_previewer` class) containing the `teal.reporter` previewer
#' functionality.
#' @export
Expand Down
2 changes: 1 addition & 1 deletion R/teal.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#' interactive data analysis environment.
#'
#' To learn mode about the package either read the project website at
#' [project website](https://insightsengineering.github.io/teal/latest-tag/) or read the [`init`] manual pages.
#' [project website](https://insightsengineering.github.io/teal/latest-tag/) or read the [init()] manual pages.
#'
#' @keywords internal
"_PACKAGE"
Expand Down
2 changes: 1 addition & 1 deletion R/teal_data_module.R
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
#'
#' @name teal_data_module
#'
#' @seealso [`teal_data-class`], [`teal.code::qenv()`]
#' @seealso [teal.data::`teal_data-class`], [teal.code::qenv()]
#'
#' @export
teal_data_module <- function(ui, server) {
Expand Down
6 changes: 3 additions & 3 deletions R/teal_reporter.R
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ TealReportCard <- R6::R6Class( # nolint: object_name_linter.
#' the default `yaml::as.yaml` to format the list.
#' If the filter state list is empty, nothing is appended to the `content`.
#'
#' @param fs (`teal_slices`) object returned from [`teal_slices()`] function.
#' @param fs (`teal_slices`) object returned from [teal_slices()] function.
#' @return invisibly self
append_fs = function(fs) {
checkmate::assert_class(fs, "teal_slices")
Expand Down Expand Up @@ -81,7 +81,7 @@ TealSlicesBlock <- R6::R6Class( # nolint: object_name_linter.
#'
#' @details Returns a `TealSlicesBlock` object with no content and no parameters.
#'
#' @param content (`teal_slices`) object returned from [`teal_slices()`] function.
#' @param content (`teal_slices`) object returned from [teal_slices()] function.
#' @param style (`character(1)`) string specifying style to apply.
#'
#' @return `TealSlicesBlock`
Expand All @@ -99,7 +99,7 @@ TealSlicesBlock <- R6::R6Class( # nolint: object_name_linter.
#' When `selected` field in `teal_slice` object is a range, then it is displayed as a "min"
#'
#'
#' @param content (`teal_slices`) object returned from [`teal_slices()`] function.
#' @param content (`teal_slices`) object returned from [teal_slices()] function.
#' @return invisibly self
set_content = function(content) {
checkmate::assert_class(content, "teal_slices")
Expand Down
4 changes: 2 additions & 2 deletions R/teal_slices.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#' [`teal`'s GitHub repository](https://github.com/insightsengineering/teal/)._
#'
#' (named `list`) specifies which filters will be active in which modules on app start.
#' Elements should contain character vector of `teal_slice` `id`s (see [`teal.slice::teal_slice()`]).
#' Elements should contain character vector of `teal_slice` `id`s (see [`teal.slice::teal_slice`]).
#' Names of the list should correspond to `teal_module` `label` set in [module()] function.
#' - `id`s listed under `"global_filters` will be active in all modules.
#' - If missing, all filters will be applied to all modules.
Expand All @@ -35,7 +35,7 @@
#' @return
#' A `teal_slices` object.
#'
#' @seealso [`teal.slice::teal_slices`], [`teal.slice::teal_slice`], [`slices_store`]
#' @seealso [`teal.slice::teal_slices`], [`teal.slice::teal_slice`], [slices_store()]
#'
#' @examples
#' filter <- teal_slices(
Expand Down
2 changes: 1 addition & 1 deletion man/example_module.Rd

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

2 changes: 1 addition & 1 deletion man/filter_calls_module.Rd

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

3 changes: 1 addition & 2 deletions man/init.Rd

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

2 changes: 1 addition & 1 deletion man/module.Rd

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

2 changes: 1 addition & 1 deletion man/reporter_previewer_module.Rd

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

4 changes: 2 additions & 2 deletions man/snapshot_manager_module.Rd

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

3 changes: 1 addition & 2 deletions man/srv_teal_with_splash.Rd

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

2 changes: 1 addition & 1 deletion man/teal-package.Rd

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

2 changes: 1 addition & 1 deletion man/teal_data_module.Rd

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

4 changes: 2 additions & 2 deletions man/teal_slices.Rd

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

3 changes: 1 addition & 2 deletions man/ui_teal_with_splash.Rd

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

0 comments on commit a6b98fe

Please sign in to comment.