From 430270adaa857902b0fea46a71bb7a7ec76808a0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 19 Oct 2023 09:38:48 +0000 Subject: [PATCH] Update pkgdown documentation f6ee3647f808abcb587c9ad2a705f59eadc22c77 --- main/404.html | 12 +- main/CODE_OF_CONDUCT.html | 12 +- main/CONTRIBUTING.html | 12 +- main/LICENSE-text.html | 12 +- main/SECURITY.html | 12 +- .../adding-support-for-reporting.html | 12 +- main/articles/blueprint/actors.html | 12 +- main/articles/blueprint/dataflow.html | 12 +- main/articles/blueprint/ddl.html | 12 +- main/articles/blueprint/filter_panel.html | 12 +- main/articles/blueprint/index.html | 12 +- main/articles/blueprint/intro.html | 12 +- .../blueprint/module_encapsulation.html | 12 +- main/articles/blueprint/products_map.html | 12 +- main/articles/blueprint/qenv.html | 12 +- main/articles/creating-custom-modules.html | 12 +- main/articles/filter-panel.html | 12 +- .../articles/including-adam-data-in-teal.html | 12 +- .../including-general-data-in-teal.html | 12 +- main/articles/including-mae-data-in-teal.html | 12 +- main/articles/index.html | 12 +- main/articles/preprocessing-data.html | 12 +- main/articles/teal-bs-themes.html | 12 +- main/articles/teal-options.html | 12 +- main/articles/teal.html | 12 +- main/authors.html | 12 +- main/index.html | 12 +- main/news/index.html | 17 +- main/pkgdown.yml | 2 +- main/pull_request_template.html | 12 +- main/reference/TealReportCard.html | 12 +- main/reference/TealSlicesBlock.html | 12 +- main/reference/append_module.html | 12 +- main/reference/calculate_hashes.html | 12 +- main/reference/deep_copy_filter.html | 12 +- main/reference/dot-datasets_to_data.html | 12 +- main/reference/example_cdisc_data.html | 12 +- main/reference/example_datasets.html | 12 +- main/reference/example_module.html | 12 +- main/reference/example_modules.html | 12 +- main/reference/filter_calls_module.html | 12 +- main/reference/filter_manager_module_srv.html | 12 +- main/reference/get_client_timezone.html | 12 +- main/reference/get_code_tdata.html | 12 +- main/reference/get_datasets_code.html | 12 +- main/reference/get_join_keys.html | 12 +- main/reference/get_metadata.html | 12 +- main/reference/get_rcode_libraries.html | 12 +- main/reference/get_teal_bs_theme.html | 12 +- main/reference/include_css_files.html | 12 +- main/reference/include_js_files.html | 12 +- main/reference/include_teal_css_js.html | 12 +- main/reference/index.html | 12 +- main/reference/init.html | 12 +- main/reference/is_arg_used.html | 12 +- main/reference/matrix_to_mapping.html | 12 +- main/reference/module.html | 12 +- main/reference/module_filter_manager.html | 12 +- .../module_filter_manager_modal.html | 12 +- main/reference/module_nested_tabs.html | 12 +- main/reference/module_tabs_with_filters.html | 12 +- main/reference/module_teal.html | 12 +- main/reference/modules.html | 12 +- main/reference/modules_depth.html | 12 +- main/reference/reexports.html | 12 +- main/reference/report_card_template.html | 12 +- main/reference/reporter_previewer_module.html | 12 +- main/reference/run_js_files.html | 12 +- main/reference/show_rcode_modal.html | 12 +- main/reference/slices_restore.html | 145 +++++++++++++++ main/reference/slices_store.html | 167 ++++++++++++++++++ main/reference/snapshot_manager_module.html | 14 +- main/reference/srv_teal_with_splash.html | 12 +- main/reference/tdata.html | 12 +- main/reference/tdata2env.html | 12 +- main/reference/teal-package.html | 12 +- main/reference/teal_slices.html | 12 +- main/reference/ui_teal_with_splash.html | 12 +- main/reference/unfold_mapping.html | 12 +- main/reference/validate_has_data.html | 12 +- main/reference/validate_has_elements.html | 12 +- main/reference/validate_has_variable.html | 12 +- main/reference/validate_in.html | 12 +- main/reference/validate_inputs.html | 12 +- main/reference/validate_n_levels.html | 12 +- main/reference/validate_no_intersection.html | 12 +- main/reference/validate_one_row_per_id.html | 12 +- main/search.json | 2 +- main/sitemap.xml | 6 + 89 files changed, 408 insertions(+), 929 deletions(-) create mode 100644 main/reference/slices_restore.html create mode 100644 main/reference/slices_store.html diff --git a/main/404.html b/main/404.html index 750788fb1f..1e9df82999 100644 --- a/main/404.html +++ b/main/404.html @@ -25,7 +25,7 @@ teal - 0.14.0.9011 + 0.14.0.9012
part of NESTpharmaverse
+ + + + + +
+
+
+

Restore teal_slices object from a file

+ Source: R/teal_slices-store.R +
slices_restore.Rd
+
+ +
+

This function takes a file path to a JSON file containing a teal_slices object +and restores it to its original form. The restored teal_slices object can be used +to access filter states and their corresponding attributes.

+
+ +
+

Usage

+ 
slices_restore(file)
+
+ +
+

Arguments

+
file
+

Path to file where teal_slices is stored. Must have a .json extension and read access.

+ +
+
+

Value

+ + +

A teal_slices object restored from the file.

+
+ +
+

Examples

+ 
if (interactive()) {
+  # Restore a teal_slices object from a file
+  tss_restored <- slices_restore("path/to/file.json")
+}
+
+
+
+
+ + +
+ + + + + + + diff --git a/main/reference/slices_store.html b/main/reference/slices_store.html new file mode 100644 index 0000000000..b02cbf1aec --- /dev/null +++ b/main/reference/slices_store.html @@ -0,0 +1,167 @@ + +Store teal_slices object to a file — slices_store • teal + Skip to contents + + +
+
+
+

Store teal_slices object to a file

+ Source: R/teal_slices-store.R +
slices_store.Rd
+
+ +
+

This function takes a teal_slices object and saves it to a file in JSON format. +The teal_slices object contains information about filter states and can be used to +create, modify, and delete filter states. The saved file can be later loaded using +the slices_restore function.

+
+ +
+

Usage

+ 
slices_store(tss, file)
+
+ +
+

Arguments

+
tss
+

(teal_slices) object to be stored.

+ + +
file
+

(character(1)) The file path where teal_slices object will be saved. +The file extension should be ".json".

+ +
+
+

Value

+ + +

NULL, invisibly.

+
+
+

Details

+

Date class is stored in "ISO8601" format (YYYY-MM-DD). POSIX*t classes are converted to a +character by using format.POSIX*t(usetz = TRUE, tz = "UTC") (YYYY-MM-DD {N}{N}:{N}{N}:{N}{N} UTC, where +{N} = [0-9] is a number and UTC is Coordinated Universal Time timezone short-code). +This format is assumed during slices_restore. All POSIX*t objects in selected or choices fields of +teal_slice objects are always printed in UTC timezone as well.

+
+ +
+

Examples

+ 
# Create a teal_slices object
+tss <- teal_slices(
+  teal_slice(dataname = "data", varname = "var"),
+  teal_slice(dataname = "data", expr = "x > 0", id = "positive_x", title = "Positive x")
+)
+
+if (interactive()) {
+  # Store the teal_slices object to a file
+  slices_store(tss, "path/to/file.json")
+}
+
+
+
+
+ + +
+ + + + + + + diff --git a/main/reference/snapshot_manager_module.html b/main/reference/snapshot_manager_module.html index f34d7ef711..4500df3a65 100644 --- a/main/reference/snapshot_manager_module.html +++ b/main/reference/snapshot_manager_module.html @@ -10,7 +10,7 @@ teal - 0.14.0.9011 + 0.14.0.9012
part of NESTpharmaverse