From 6b6e007a8513d97d771b49c571126503a764cf1a Mon Sep 17 00:00:00 2001 From: rescalan Date: Wed, 2 Dec 2020 08:16:07 -0800 Subject: [PATCH] Update imports and documentation --- DESCRIPTION | 1 + NAMESPACE | 1 + man/chartsRenderStatic.Rd | 2 +- man/chartsRenderStaticUI.Rd | 2 +- man/chartsTab.Rd | 6 +++--- man/generateMappingList.Rd | 4 ++-- 6 files changed, 9 insertions(+), 7 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index ad5fc0d9..8abb3979 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -27,6 +27,7 @@ Suggests: plotly Imports: dplyr, + esquisse, htmlwidgets, purrr, stringr, diff --git a/NAMESPACE b/NAMESPACE index ef59e71f..6838b273 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -31,6 +31,7 @@ export(settingsData) export(settingsDataUI) export(settingsMapping) export(settingsMappingUI) +import(DT) import(dplyr) import(shiny) importFrom(DT,DTOutput) diff --git a/man/chartsRenderStatic.Rd b/man/chartsRenderStatic.Rd index 2c15ffc2..a876df7b 100644 --- a/man/chartsRenderStatic.Rd +++ b/man/chartsRenderStatic.Rd @@ -4,7 +4,7 @@ \alias{chartsRenderStatic} \title{Charts Module - render static chart server} \usage{ -chartsRenderStatic(input, output, session, chartFunction, params) +chartsRenderStatic(input, output, session, chartFunction, params, type) } \arguments{ \item{input}{Shiny input object} diff --git a/man/chartsRenderStaticUI.Rd b/man/chartsRenderStaticUI.Rd index d35bc513..3f383eef 100644 --- a/man/chartsRenderStaticUI.Rd +++ b/man/chartsRenderStaticUI.Rd @@ -4,7 +4,7 @@ \alias{chartsRenderStaticUI} \title{Charts Module - render static chart UI} \usage{ -chartsRenderStaticUI(id) +chartsRenderStaticUI(id, type) } \description{ Charts Module - sub module for rendering a static chart diff --git a/man/chartsTab.Rd b/man/chartsTab.Rd index 7e266ea9..455f628e 100644 --- a/man/chartsTab.Rd +++ b/man/chartsTab.Rd @@ -27,7 +27,7 @@ chartsTab( \item{chart}{chart name. Should generally match the name of the function/widget/module to be intiated. See specific renderer modules for more details.} -\item{type}{type of chart. Must be 'htmlwidget', 'module', 'static' or 'plotly'. See ?mod_chartRenderer{{type}} for more details about each chart type} +\item{type}{type of chart. Must be 'htmlwidget', 'module', 'plot', 'table', 'html' or 'plotly'. See ?mod_chartRenderer* functions for more details about each chart type.} \item{package}{package containing the widget.} @@ -35,11 +35,11 @@ chartsTab( \item{initFunction}{function called before the chart is generated. The function should take `data` and `settings` as inputs and return `params` which should be a list which is then provided to the widget. If domain is specified, only domain-level information is passed to the init function, otherwise named lists containing information for all domains is provided. The mapping is parsed as a list using `generateMappingList()` before being passed to the init function. By default, init returns an unmodified list of data and settings - possibly subset to the specified domain (e.g. list(data=data, settings=settings))} -\item{domain}{data domain. Should correspond to a domain in `meta` or be set to "multiple" to named lists for data and mappings containing domains.} +\item{domain}{data domain. Should correspond to a domain in `meta` or be set to "multiple", in which case, named lists for `data` and `mappings` containing all domain data are used.} \item{data}{named list of current data sets [reactive].} -\item{mapping}{named list of the current data mappings [reactive].} +\item{mapping}{tibble capturing the current data mappings [reactive].} } \description{ server for the display of the chart tab diff --git a/man/generateMappingList.Rd b/man/generateMappingList.Rd index 58d9e4c1..604406a6 100644 --- a/man/generateMappingList.Rd +++ b/man/generateMappingList.Rd @@ -4,10 +4,10 @@ \alias{generateMappingList} \title{Convert mapping data.frame to a list} \usage{ -generateMappingList(settingsDF, domain) +generateMappingList(settingsDF, domain, pull = FALSE) } \arguments{ -\item{domain}{mapping domain to return (returns all domains as a named list by default)} +\item{domain}{call pull() the value for each parameter - needed for testing only. default: FALSE} \item{mappingDF}{data frame containing current mapping} }