diff --git a/404.html b/404.html index 79d622c4..ed303674 100644 --- a/404.html +++ b/404.html @@ -30,7 +30,7 @@ FreesearchR - 26.4.2 + 26.6.1 + + + + + +
+
+
+

Implemented functions

+ Source: R/plot-helpers.R +
available_plots.Rd
+
+ +
+

Library of supported functions. The list name and "descr" element should be +unique for each element on list.

  • fun: the plotting function

    • +

  • fun.args: default parameters for the plotting function

    • +

  • descr: Plot description

    • +

  • note: Short note/description of the function for displaying in ui and docs

    • +

  • primary.type: Primary variable data type (see data_type)

    • +

  • base: holds a list of parameters for plot input fields generation +Secondary and tertiary variable input fields are mandatory.

    • +
+ +
+

Usage

+ 
available_plots()
+
+ +
+

Value

+

list

+
+ +
+

Examples

+ 
available_plots() |> str()
+#> Error in available_plots(): object 'i18n' not found
+
+
+
+ + +
+ + + + + + + diff --git a/reference/available_plots.md b/reference/available_plots.md new file mode 100644 index 00000000..1f91542c --- /dev/null +++ b/reference/available_plots.md @@ -0,0 +1,36 @@ +# Implemented functions + +Library of supported functions. The list name and "descr" element should +be unique for each element on list. + +- fun: the plotting function + +- fun.args: default parameters for the plotting function + +- descr: Plot description + +- note: Short note/description of the function for displaying in ui and + docs + +- primary.type: Primary variable data type (see + [data_type](https://agdamsbo.github.io/FreesearchR/reference/data_type.md)) + +- base: holds a list of parameters for plot input fields generation + Secondary and tertiary variable input fields are mandatory. + +## Usage + +``` r +available_plots() +``` + +## Value + +list + +## Examples + +``` r +available_plots() |> str() +#> Error in available_plots(): object 'i18n' not found +``` diff --git a/reference/baseline_table.html b/reference/baseline_table.html index 031bde51..aa2b6d46 100644 --- a/reference/baseline_table.html +++ b/reference/baseline_table.html @@ -7,7 +7,7 @@ FreesearchR - 26.4.2 + 26.6.1 + + + + + +
+
+
+

Get the function parameters based on the selected function description

+ Source: R/plot-helpers.R +
get_input_params.Rd
+
+ +
+

Get the function parameters based on the selected function description

+
+ +
+

Usage

+ 
get_input_params(data)
+
+ +
+

Arguments

+ + +
data
+

vector

+ +
+
+

Value

+

list

+
+ +
+

Examples

+ 
ls <- mtcars |>
+  default_parsing() |>
+  dplyr::pull(mpg) |>
+  possible_plots() |>
+  (\(.x){
+    .x[[1]]
+  })() |>
+  get_input_params()
+#> Error in available_plots(): object 'i18n' not found
+
+
+
+ + +
+ + + + + + + diff --git a/reference/get_input_params.md b/reference/get_input_params.md new file mode 100644 index 00000000..16723c37 --- /dev/null +++ b/reference/get_input_params.md @@ -0,0 +1,33 @@ +# Get the function parameters based on the selected function description + +Get the function parameters based on the selected function description + +## Usage + +``` r +get_input_params(data) +``` + +## Arguments + +- data: + + vector + +## Value + +list + +## Examples + +``` r +ls <- mtcars |> + default_parsing() |> + dplyr::pull(mpg) |> + possible_plots() |> + (\(.x){ + .x[[1]] + })() |> + get_input_params() +#> Error in available_plots(): object 'i18n' not found +``` diff --git a/reference/get_label.html b/reference/get_label.html index 4fabefe9..86daaf62 100644 --- a/reference/get_label.html +++ b/reference/get_label.html @@ -7,7 +7,7 @@ FreesearchR - 26.4.2 + 26.6.1 + + + + + +
+
+
+

Wrapper for columnSelectInput

+ Source: R/plot-helpers.R +
selectPlotVariables.Rd
+
+ +
+

Wrapper for columnSelectInput

+
+ +
+

Usage

+ 
selectPlotVariables(data, exclude = NULL, allow_none = TRUE, var_types, ...)
+
+ + +
+ + +
+ + + + + + + diff --git a/reference/selectPlotVariables.md b/reference/selectPlotVariables.md new file mode 100644 index 00000000..13b70b74 --- /dev/null +++ b/reference/selectPlotVariables.md @@ -0,0 +1,9 @@ +# Wrapper for columnSelectInput + +Wrapper for columnSelectInput + +## Usage + +``` r +selectPlotVariables(data, exclude = NULL, allow_none = TRUE, var_types, ...) +``` diff --git a/reference/separate_string.html b/reference/separate_string.html index ecee51ce..5b747743 100644 --- a/reference/separate_string.html +++ b/reference/separate_string.html @@ -7,7 +7,7 @@ FreesearchR - 26.4.2 + 26.6.1