diff --git a/.Rhistory b/.Rhistory index 947c8b4..40b267e 100644 --- a/.Rhistory +++ b/.Rhistory @@ -179,3 +179,17 @@ devtools::install() pkgdown::build_site() pkgdown::build_site() pkgdown::build_site() +devtools::load_all() +devtools::document() +devtools::install() +pkgdown::build_site() +devtools::load_all() +devtools::document() +devtools::install() +pkgdown::build_site() +pkgdown::build_site() +pkgdown::build_site() +pkgdown::build_site() +devtools::load_all() +devtools::document() +devtools::install() diff --git a/.Rproj.user/F19CAEE1/pcs/source-pane.pper b/.Rproj.user/F19CAEE1/pcs/source-pane.pper index c755c58..c1bbfd9 100644 --- a/.Rproj.user/F19CAEE1/pcs/source-pane.pper +++ b/.Rproj.user/F19CAEE1/pcs/source-pane.pper @@ -1,4 +1,4 @@ { - "activeTab": 2, + "activeTab": 4, "activeTabSourceWindow0": 0 } \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/pcs/source-window.pper b/.Rproj.user/F19CAEE1/pcs/source-window.pper index 3435dfb..8f93b35 100644 --- a/.Rproj.user/F19CAEE1/pcs/source-window.pper +++ b/.Rproj.user/F19CAEE1/pcs/source-window.pper @@ -1,11 +1,11 @@ { "sourceWindowGeometry": { - "wfdasfpxkd9d6": { - "ordinal": 1, - "x": 283, - "y": 17, - "width": 980, - "height": 951 + "w7u3g5xr3cjuq": { + "ordinal": 2, + "x": 1358, + "y": 0, + "width": 1091, + "height": 1111 } } } \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/pcs/windowlayoutstate.pper b/.Rproj.user/F19CAEE1/pcs/windowlayoutstate.pper index 766365c..8f8879f 100644 --- a/.Rproj.user/F19CAEE1/pcs/windowlayoutstate.pper +++ b/.Rproj.user/F19CAEE1/pcs/windowlayoutstate.pper @@ -1,12 +1,12 @@ { "left": { - "splitterpos": 299, + "splitterpos": 298, "topwindowstate": "NORMAL", "panelheight": 714, "windowheight": 752 }, "right": { - "splitterpos": 450, + "splitterpos": 449, "topwindowstate": "MINIMIZE", "panelheight": 714, "windowheight": 752 diff --git a/.Rproj.user/F19CAEE1/rmd-outputs b/.Rproj.user/F19CAEE1/rmd-outputs index 6279ed2..6518cea 100644 --- a/.Rproj.user/F19CAEE1/rmd-outputs +++ b/.Rproj.user/F19CAEE1/rmd-outputs @@ -1,8 +1,8 @@ -C:/Users/edda/AppData/Local/Temp/RtmpGSAvMO/preview-31283c751ba3.dir/dataprep_options.html -C:/Users/edda/AppData/Local/Temp/RtmpGSAvMO/preview-31284c9e6706.dir/index_categories.html -C:/Users/edda/AppData/Local/Temp/RtmpGSAvMO/preview-312827d268b.dir/dataprep_options.html -C:/Users/edda/AppData/Local/Temp/RtmpGSAvMO/preview-31287f7c1c4b.dir/dataprep_options.html -C:/Users/edda/AppData/Local/Temp/RtmpGSAvMO/preview-3128101b73b7.dir/dataprep_options.html +C:/Users/edda/AppData/Local/Temp/RtmpE1gk4u/preview-5f7c656b5be.dir/titles_options.html +C:/Users/edda/AppData/Local/Temp/RtmpE1gk4u/preview-5f7c40077a4f.dir/theme_options.html +C:/Users/edda/AppData/Local/Temp/RtmpE1gk4u/preview-5f7c648a10e5.dir/theme_options.html +C:/Users/edda/AppData/Local/Temp/RtmpE1gk4u/preview-5f7c6d09426e.dir/colorprep_options.html +C:/Users/edda/AppData/Local/Temp/RtmpE1gk4u/preview-5f7c21ce52d.dir/axis_options.html diff --git a/.Rproj.user/F19CAEE1/sources/per/t/88C5DFBA b/.Rproj.user/F19CAEE1/sources/per/t/88C5DFBA deleted file mode 100644 index a7c8ffb..0000000 --- a/.Rproj.user/F19CAEE1/sources/per/t/88C5DFBA +++ /dev/null @@ -1,26 +0,0 @@ -{ - "id": "88C5DFBA", - "path": "~/Nicolas_Datasktch/dsopts/_pkgdown.yml", - "project_path": "_pkgdown.yml", - "type": "yaml", - "hash": "648081852", - "contents": "", - "dirty": false, - "created": 1708025377826.0, - "source_on_save": false, - "relative_order": 4, - "properties": { - "source_window_id": "", - "Source": "Source", - "cursorPosition": "13,37", - "scrollLine": "0" - }, - "folds": "", - "lastKnownWriteTime": 1708365275, - "encoding": "UTF-8", - "collab_server": "", - "source_window": "", - "last_content_update": 1708365275579, - "read_only": false, - "read_only_alternatives": [] -} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/per/t/88C5DFBA-contents b/.Rproj.user/F19CAEE1/sources/per/t/88C5DFBA-contents deleted file mode 100644 index f968935..0000000 --- a/.Rproj.user/F19CAEE1/sources/per/t/88C5DFBA-contents +++ /dev/null @@ -1,16 +0,0 @@ -template: - bootstrap: 5 - bootswatch: materia - bslib: - pkgdown-nav-height: 100px - primary: "#306cc9" - -navbar: - structure: - left: [reference, Categories] - components: - Categories: - text: Categories - href: articles/index_categories.html - - diff --git a/.Rproj.user/F19CAEE1/sources/prop/04B2249F b/.Rproj.user/F19CAEE1/sources/prop/04B2249F new file mode 100644 index 0000000..50536bf --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/prop/04B2249F @@ -0,0 +1,6 @@ +{ + "source_window_id": "", + "Source": "Source", + "cursorPosition": "127,151", + "scrollLine": "0" +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/0F6405A5 b/.Rproj.user/F19CAEE1/sources/prop/0F6405A5 new file mode 100644 index 0000000..bb27690 --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/prop/0F6405A5 @@ -0,0 +1,4 @@ +{ + "source_window_id": "", + "Source": "Source" +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/1B7CCF6F b/.Rproj.user/F19CAEE1/sources/prop/1B7CCF6F index ed2b807..d311a77 100644 --- a/.Rproj.user/F19CAEE1/sources/prop/1B7CCF6F +++ b/.Rproj.user/F19CAEE1/sources/prop/1B7CCF6F @@ -2,7 +2,7 @@ "tempName": "Untitled1", "source_window_id": "", "Source": "Source", - "cursorPosition": "64,29", - "scrollLine": "49", + "cursorPosition": "59,31", + "scrollLine": "0", "last_setup_crc32": "" } \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/71A9CD6E b/.Rproj.user/F19CAEE1/sources/prop/71A9CD6E new file mode 100644 index 0000000..bb27690 --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/prop/71A9CD6E @@ -0,0 +1,4 @@ +{ + "source_window_id": "", + "Source": "Source" +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/8ACD0A57 b/.Rproj.user/F19CAEE1/sources/prop/8ACD0A57 new file mode 100644 index 0000000..fac207a --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/prop/8ACD0A57 @@ -0,0 +1,6 @@ +{ + "source_window_id": "", + "Source": "Source", + "cursorPosition": "107,0", + "scrollLine": "0" +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/9513466F b/.Rproj.user/F19CAEE1/sources/prop/9513466F new file mode 100644 index 0000000..350c2cd --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/prop/9513466F @@ -0,0 +1,12 @@ +{ + "tempName": "Untitled1", + "source_window_id": "", + "Source": "Source", + "cursorPosition": "177,47", + "scrollLine": "0", + "rmdVisualMode": "false", + "rmdVisualCollapsedChunks": "", + "rmdVisualModeLocation": "20283:10972.22265625", + "rmdVisualWrapConfigured": "true", + "docOutlineVisible": "1" +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/A952B194 b/.Rproj.user/F19CAEE1/sources/prop/A952B194 new file mode 100644 index 0000000..bb27690 --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/prop/A952B194 @@ -0,0 +1,4 @@ +{ + "source_window_id": "", + "Source": "Source" +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/CA034A84 b/.Rproj.user/F19CAEE1/sources/prop/CA034A84 new file mode 100644 index 0000000..b129eff --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/prop/CA034A84 @@ -0,0 +1,6 @@ +{ + "source_window_id": "", + "Source": "Source", + "cursorPosition": "61,233", + "scrollLine": "0" +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/CDE1B082 b/.Rproj.user/F19CAEE1/sources/prop/CDE1B082 new file mode 100644 index 0000000..d196a66 --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/prop/CDE1B082 @@ -0,0 +1,6 @@ +{ + "source_window_id": "", + "Source": "Source", + "cursorPosition": "56,196", + "scrollLine": "0" +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/prop/D3852156 b/.Rproj.user/F19CAEE1/sources/prop/D3852156 index e951a09..e90e8e6 100644 --- a/.Rproj.user/F19CAEE1/sources/prop/D3852156 +++ b/.Rproj.user/F19CAEE1/sources/prop/D3852156 @@ -2,8 +2,8 @@ "tempName": "Untitled1", "source_window_id": "", "Source": "Source", - "cursorPosition": "129,388", - "scrollLine": "122", + "cursorPosition": "84,69", + "scrollLine": "0", "rmdVisualMode": "false", "rmdVisualWrapConfigured": "true", "docOutlineVisible": "1", diff --git a/.Rproj.user/F19CAEE1/sources/prop/INDEX b/.Rproj.user/F19CAEE1/sources/prop/INDEX index a5bb031..4bb3933 100644 --- a/.Rproj.user/F19CAEE1/sources/prop/INDEX +++ b/.Rproj.user/F19CAEE1/sources/prop/INDEX @@ -11,10 +11,18 @@ ~%2FNicolas_Datasktch%2Fdsopts%2Fman%2Fdsopts_available.Rd="322D64A4" ~%2FNicolas_Datasktch%2Fdsopts%2Fman%2Fdsopts_merge.Rd="A122837E" ~%2FNicolas_Datasktch%2Fdsopts%2Fvi%C3%B1eta-argumentos.Rmd="3F230BAF" +~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2F_pkgdown.yml="A952B194" ~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Fargui.Rmd="58F42BB4" +~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Faxis_options.Rmd="8ACD0A57" +~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Fcolorprep_options.Rmd="CDE1B082" ~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Fcolors.Rmd="8CDB7B7B" +~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Fcolorsprep_options.Rmd="CA034A84" ~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Fdataprep_options.Rmd="D3852156" ~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Findex_categories.Rmd="1B7CCF6F" ~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Findexcat.Rmd="1CECA18A" +~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Ftheme_options.Rmd="9513466F" ~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Ftitles.Rmd="9DE666F4" +~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Ftitles_options.Rmd="04B2249F" ~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Fvi%C3%B1eta-argumentos.Rmd="C00B4686" +~%2FNicolas_Datasktch%2Fdsopts%2Fvignettes%2Fvignettes2.0.Rmd="71A9CD6E" +~%2Fvignettes%2Fcolorsprepsss_options.Rmd="0F6405A5" diff --git a/.Rproj.user/F19CAEE1/sources/per/t/EE658456 b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/22FD9563 similarity index 74% rename from .Rproj.user/F19CAEE1/sources/per/t/EE658456 rename to .Rproj.user/F19CAEE1/sources/session-7e2f6534/22FD9563 index 86930a6..facc405 100644 --- a/.Rproj.user/F19CAEE1/sources/per/t/EE658456 +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/22FD9563 @@ -1,20 +1,20 @@ { - "id": "EE658456", + "id": "22FD9563", "path": "~/Nicolas_Datasktch/dsopts/vignettes/dataprep_options.Rmd", "project_path": "vignettes/dataprep_options.Rmd", "type": "r_markdown", - "hash": "3383314325", + "hash": "0", "contents": "", "dirty": false, - "created": 1708024639991.0, + "created": 1708715101473.0, "source_on_save": true, - "relative_order": 2, + "relative_order": 3, "properties": { "tempName": "Untitled1", "source_window_id": "", "Source": "Source", - "cursorPosition": "129,388", - "scrollLine": "122", + "cursorPosition": "84,69", + "scrollLine": "0", "rmdVisualMode": "false", "rmdVisualWrapConfigured": "true", "docOutlineVisible": "1", @@ -23,11 +23,11 @@ "docOutlineSize": "117" }, "folds": "", - "lastKnownWriteTime": 1708370480, + "lastKnownWriteTime": 1708716720, "encoding": "UTF-8", "collab_server": "", "source_window": "", - "last_content_update": 1708370480119, + "last_content_update": 1708716720862, "read_only": false, "read_only_alternatives": [] } \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/per/t/EE658456-contents b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/22FD9563-contents similarity index 59% rename from .Rproj.user/F19CAEE1/sources/per/t/EE658456-contents rename to .Rproj.user/F19CAEE1/sources/session-7e2f6534/22FD9563-contents index 3dc262a..8c1018c 100644 --- a/.Rproj.user/F19CAEE1/sources/per/t/EE658456-contents +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/22FD9563-contents @@ -54,77 +54,76 @@ vignette: > -This document aims to explain the options available in the dataprep category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. +This page aims to explain the options available in the dataprep category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. #### agg -Determines how data is summarized or combined (e.g., sums, averages, maximums, minimums). It expects a character value specifying the aggregation function (mean, max, min, etc.). Its default value is "sum," and its hd_type is Categorical (Cat). - +Determines how data is summarized or combined (e.g., sums, averages, maximums, minimums). It expects a character value (hdtype Cat) specifying the aggregation function (mean, max, min, etc.). Its default value is "sum". #### agg_na_rm -Indicates whether missing values (NA) should be removed before aggregating data. It expects a value of type logical, which represents boolean values (with possible values being True or False). By default, its value is TRUE, and its hd_type is Check (Chk). +Indicates whether missing values (NA) should be removed before aggregating data. It expects a value of type logical, which represents boolean values (hdtype Chk) True or False and by default, its value is TRUE. #### agg_text -Used as a label in the column name indicating the type of aggregation performed on the data. It has a default value of NULL and an hd_type of Txt (Text). Possible values include 'sum VAR,' 'mean VAR,' 'max VAR,' indicating the aggregation type (summed, averaged, or maximum value taken) for the data in the column. +Used as a label in the column name indicating the type of aggregation performed on the data. It expects a character value (hdtype Txt) and has a default value of NULL. Possible values include 'sum VAR,' 'mean VAR,' 'max VAR,' indicating the aggregation type (summed, averaged, or maximum value taken) for the data in the column. #### drop_na -Enhances the clarity of visual representations by excluding missing data (NA) when set to TRUE. Its hdtype is Chk (Check), expecting a logical value (TRUE or FALSE) and by default, its value is FALSE. +Enhances the clarity of visual representations by excluding missing data (NA) when set to TRUE. It expects a logical value (hdtype Chk) TRUE or FALSE, and by default, its value is FALSE. #### drop_na_var2 -Removes missing data (NA) from a second variable in the visualization. Its default value is FALSE, its `hdtype` is Chk (Check), and its possible values are TRUE or FALSE. +Removes missing data (NA) from a second variable in the visualization. Its default value is FALSE and its possible values are TRUE or FALSE (hdtype Chk). #### format_number_prefix -Formats numeric values using SI prefixes to represent large numbers in a more readable format such as k (thousands), M (millions) in numeric values.It expects a logical value (TRUE or FALSE), with a default value of FALSE and an hdtype of chk (Check). +Formats numeric values using SI prefixes to represent large numbers in a more readable format such as k (thousands), M (millions) in numeric values. It expects a logical value (hdtype Chk) TRUE or FALSE, with a default value of FALSE. #### format_sample_cat -Allows specifying how categorical data should be formatted, such as whether to convert them to uppercase, lowercase, etc. Its `hdtype` is Txt (text) and Its default value is NULL, which means no default formatting is applied. +Allows specifying how categorical data should be formatted, such as whether to convert them to uppercase, lowercase, etc. It expects a character value (hdtype Txt) and its default value is NULL, which means no default formatting is applied. #### format_sample_dat -Used to format date-type data and allows to specify how date-type data should be formatted (for example YYYY-MM-DD or DD/MM/YYYY). its hdtype is Txt (text) and the default value is NULL, indicating that no specific formatting is applied by default. +Used to format date-type data and allows to specify how date-type data should be formatted (for example YYYY-MM-DD or DD/MM/YYYY). It expects a character value (hdtype Txt) and the default value is NULL, indicating that no specific formatting is applied by default. #### format_sample_num -Used to set the format for numbers in the visualization. If no format is specified for axes, all numbers will use the format specified by this argument. The default value is 1500(Review) and this argument expects a `character` type (Review). +Used to set the format for numbers in the visualization. If no format is specified for axes, all numbers will use the format specified by this argument. The default value is 1500 and this argument expects a `character` type (hdtype Txt). #### na_label -Replaces NA values in a dataset with a specified label. For example, setting na_label = "Not Available" would display "Not Available" instead of NA in the visual representation of the data. It has an hdtype of Txt (text) and expects a character type value. +Replaces NA values in a dataset with a specified label. For example, setting na_label = "Not Available" would display "Not Available" instead of NA in the visual representation of the data. It expects a character type value (hdtype Txt). #### percentage -Calculates the percentage for the indicated numerical variable. Its default value is FALSE, its `hdtype` is chk (check) and this argument expects a logical value (TRUE or FALSE) +Calculates the percentage for the indicated numerical variable. Its default value is FALSE and this argument expects a logical value (hdtype Chk) TRUE or FALSE. #### percentage_col -Specifies the name or names of the categorical variable(s) for which you want to calculate percentages. For example, if you have a dataset with columns "category" and "value" representing different categories and their corresponding values, you can use percentage_col = "category" to calculate the percentage of each category. Its default value is NULL, and its `hdtype` is Txt (text). +Specifies the name or names of the categorical variable(s) for which you want to calculate percentages. For example, if you have a dataset with columns "category" and "value" representing different categories and their corresponding values, you can use percentage_col = "category" to calculate the percentage of each category. Its default value is NULL, and expects a character value (hdtype Txt). #### percentage_intra -Calculates percentages within individual categories or groups in a visualization. Defaulting to FALSE, with a expect logical value and its hdtype is Chk (Check). +Calculates percentages within individual categories or groups in a visualization. Defaulting to FALSE, with a expect logical value TRUE or FALSE (hdtype Chk). #### percentage_name -Specifies a character value that will be used as the name for the column containing the calculated percentages. It is used to provide a more descriptive name for the percentage column in the output visualization or dataset if `percentage` is TRUE. Its `hdtype` is Txt (text) and the type of the input is character (text). +Specifies a character value that will be used as the name for the column containing the calculated percentages. It provides a more descriptive name for the percentage column in the output visualization or dataset. By default, the value is NULL and The type value is character (hdtype Txt). #### tooltip_agg_collapse_rows_template -Controls the aggregation of data in tooltips, determining whether similar or related rows are collapsed into a single entry in the tooltip to avoid repetition. It takes a dataframe and a template as inputs and returns a column of strings with the applied template. The template can apply different aggregations such as mean or max. Its `hdtype` is Cat (categorical) and Its possible values are functions such as sum, mean, etc., which are used to specify the type of aggregation for the tooltip. +Controls the aggregation of data in tooltips, determining whether similar or related rows are collapsed into a single entry in the tooltip to avoid repetition. It takes a dataframe and a template as inputs and returns a column of strings with the applied template. The template can apply different aggregations such as mean or max. The template can apply different aggregations such as mean or max. Its possible values are functions such as sum, mean, etc (hdtype Cat) which are used to specify the type of aggregation for the tooltip. #### tooltip_include_all_vars -Includes all available variables in the entered dataframe for visualization. It has a default value of FALSE and Its `hdtype` is Chk (Check). +Includes all available variables in the entered dataframe for visualization. It has a default value of FALSE and and expects a logical value TRUE or FALSE (hdtype Chk). #### tooltip_sep_all_vars -Specifies the separator used in tooltips when multiple variables are included, allowing for clear separation and organization of information. Its `hdtype` is Cat (categorical). +Specifies the separator used in tooltips when multiple variables are included, allowing for clear separation and organization of information. It expects a character value (hdtype Cat). #### tooltip_template -Used as a customization template for tooltips, this template allows you to customize the content and format of tooltips in a visualization, using specific variables from the dataframe to display detailed and relevant information when hovering over elements of the visualization.Its hdtype is Txt (text), and the possible values are text that match the names of variables in the dataframe. +Used as a customization template for tooltips, this template allows you to customize the content and format of tooltips in a visualization, using specific variables from the dataframe to display detailed and relevant information when hovering over elements of the visualization. The possible values are character (hdtype Txt) that match the names of variables in the dataframe. diff --git a/.Rproj.user/F19CAEE1/sources/per/t/E219DC33 b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/5C3890E4 similarity index 71% rename from .Rproj.user/F19CAEE1/sources/per/t/E219DC33 rename to .Rproj.user/F19CAEE1/sources/session-7e2f6534/5C3890E4 index 96fd71a..c92819e 100644 --- a/.Rproj.user/F19CAEE1/sources/per/t/E219DC33 +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/5C3890E4 @@ -1,28 +1,28 @@ { - "id": "E219DC33", + "id": "5C3890E4", "path": "~/Nicolas_Datasktch/dsopts/vignettes/index_categories.Rmd", "project_path": "vignettes/index_categories.Rmd", "type": "r_markdown", - "hash": "677186710", + "hash": "0", "contents": "", "dirty": false, - "created": 1708111439999.0, + "created": 1708715096915.0, "source_on_save": true, "relative_order": 4, "properties": { "tempName": "Untitled1", "source_window_id": "", "Source": "Source", - "cursorPosition": "64,29", - "scrollLine": "49", + "cursorPosition": "59,31", + "scrollLine": "0", "last_setup_crc32": "" }, "folds": "", - "lastKnownWriteTime": 1708370488, + "lastKnownWriteTime": 1708716715, "encoding": "UTF-8", "collab_server": "", "source_window": "", - "last_content_update": 1708370488532, + "last_content_update": 1708716715473, "read_only": false, "read_only_alternatives": [] } \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/per/t/E219DC33-contents b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/5C3890E4-contents similarity index 83% rename from .Rproj.user/F19CAEE1/sources/per/t/E219DC33-contents rename to .Rproj.user/F19CAEE1/sources/session-7e2f6534/5C3890E4-contents index af02cc6..1d58942 100644 --- a/.Rproj.user/F19CAEE1/sources/per/t/E219DC33-contents +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/5C3890E4-contents @@ -52,16 +52,11 @@ vignette: > } -This section provides an overview of all the categories in which specific arguments are classified. - -```{r setup, include = FALSE} -knitr::opts_chunk$set( - collapse = TRUE, - comment = "#>" -) -``` - +* [axis](axis_options.html) +* [colorprep](colorprep_options.html) * [dataprep](dataprep_options.html) +* [theme](theme_options.html) +* [titles](titles_options.html) diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/74AA776B b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/74AA776B new file mode 100644 index 0000000..30ff179 --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/74AA776B @@ -0,0 +1,26 @@ +{ + "id": "74AA776B", + "path": "~/Nicolas_Datasktch/dsopts/vignettes/axis_options.Rmd", + "project_path": "vignettes/axis_options.Rmd", + "type": "r_markdown", + "hash": "0", + "contents": "", + "dirty": false, + "created": 1708715109687.0, + "source_on_save": true, + "relative_order": 1, + "properties": { + "source_window_id": "", + "Source": "Source", + "cursorPosition": "107,0", + "scrollLine": "0" + }, + "folds": "", + "lastKnownWriteTime": 1708716727, + "encoding": "UTF-8", + "collab_server": "", + "source_window": "", + "last_content_update": 1708716727337, + "read_only": false, + "read_only_alternatives": [] +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/74AA776B-contents b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/74AA776B-contents new file mode 100644 index 0000000..e9747d4 --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/74AA776B-contents @@ -0,0 +1,120 @@ +--- +title: "axis options" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{axis options} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + + +This page aims to explain the options available in the axis category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. + +#### axis_flip + +Swaps the X and Y axes in a plot. By default, it is set to FALSE, meaning the axes are not flipped. When set to TRUE, the orientation of the plot changes. This argument expects a logical values (hdtype Chk). + +#### axis_line_x_size + +Specifies the size or thickness of the X-axis line in a plot. The default size is 0 and It expects a value of type numeric (hdtype Num). + +#### axis_reversed + +Reverses the axes of the plot, such as flipping the Y-axis so that higher values appear at the bottom.The default value is FALSE, meaning the axes are not reversed. Its value type is logical (hdtype Chk), with possible values of TRUE or FALSE. + +#### axis_text_angle + +Specifies the angle of the axis text in a graphic. This can help improve readability when there are many labels or when labels are long. The default angle is 0 degrees, which means the text is horizontal.You can specify an angle between -90 and 90 degrees to rotate the text. It expects a value of type numeric (hdtype Num). + +#### axis_text_wrap + +Specifies the number of words to wrap in axis labels before wrapping onto the next line. By default, it is set to 6, so axis labels will wrap to the next line after 6 words. This allows long labels to be displayed on multiple lines, improving readability. It expects a value of type numeric (hdtype Num). + +#### axis_x_reversed + +Reverses the order of the data on the X-axis of a chart. When set to True, the highest values appear on the left and the lowest values on the right. It expects a value of type logical (hdtype Chk). + +#### axis_x_text_angle + +Specifies the angle of the labels on the X-axis in a chart.The default value is NULL, which means no rotation is applied. Also, you can specify an angle between -90 and 90 degrees to rotate the text. It expects a value of type numeric (hdtype Num). + +#### axis_x_text_wrap + +Specifies the number of words in the labels on the X-axis in a chart. This allows long labels to be displayed on multiple lines and avoids text overlap. The default value is NULL, indicating that no word wrapping is applied. It expects a value of type numeric (hdtype Num). + +#### axis_y_reversed + +Inverts the axes of the chart (e.g., reverses the Y-axis so that higher values are closer to the origin). If the chart is flipped, the X-axis is reversed by default and means that the order of the data on the Y-axis is reversed. The default value is FALSE, indicating that the axes are not reversed. It expects a value of type logical (hdtype Chk). + +#### axis_y_text_angle + +Controls the angle of the labels on the Y-axis. The default value is NULL, which means no rotation is applied. The angle can range from -90 to 90 degrees. It expects a value of type numeric (hdtype Num). + +#### axis_y_text_wrap + +Specifies the number of words in the labels of the Y-axis in a chart. This parameter allows long labels to be displayed on multiple lines, preventing text overlap. The default value is NULL, indicating that no word wrapping is applied. It expects a value of type numeric (hdtype Num). + +#### title_axis_color + +Specifies the color of the text used for the axis titles in a chart. This helps distinguish the axis titles from other text in the visualization. The default value is NULL, indicating that the color is not explicitly set. It expects a value of type character (hdtype Clr). + +#### title_axis_size + +Defines the font size for the axis titles in a graphic. The default size is 13 points, and you can specify values from 1 to 20 points. It expects a value of type numeric (hdtype Num). + +#### title_axis_x + +Specifies the title for the X-axis of a chart, describing the variable or data represented on the horizontal axis. It expects a value of type character (hdtype Txt). + +#### title_axis_y + +Specifies the title for the Y-axis of a chart, describing the variable or data represented on the vertical axis. It expects a value of type character (hdtype Txt). + +#### title_axis_y2 + +Specifies the title for the secondary Y-axis in a chart. In charts with two Y-axes, each axis can represent different types of data or scales, and this title would help identify the nature of the data represented by the secondary Y-axis. The default value is NULL and the argument expects a value of type character (hdtype Txt). + diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/7D89B904 b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/7D89B904 new file mode 100644 index 0000000..9daf622 --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/7D89B904 @@ -0,0 +1,32 @@ +{ + "id": "7D89B904", + "path": "~/Nicolas_Datasktch/dsopts/vignettes/theme_options.Rmd", + "project_path": "vignettes/theme_options.Rmd", + "type": "r_markdown", + "hash": "0", + "contents": "", + "dirty": false, + "created": 1708543067876.0, + "source_on_save": true, + "relative_order": 5, + "properties": { + "tempName": "Untitled1", + "source_window_id": "", + "Source": "Source", + "cursorPosition": "177,47", + "scrollLine": "0", + "rmdVisualMode": "false", + "rmdVisualCollapsedChunks": "", + "rmdVisualModeLocation": "20283:10972.22265625", + "rmdVisualWrapConfigured": "true", + "docOutlineVisible": "1" + }, + "folds": "", + "lastKnownWriteTime": 1708716866, + "encoding": "UTF-8", + "collab_server": "", + "source_window": "", + "last_content_update": 1708716867093, + "read_only": false, + "read_only_alternatives": [] +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/7D89B904-contents b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/7D89B904-contents new file mode 100644 index 0000000..0a1a2f7 --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/7D89B904-contents @@ -0,0 +1,817 @@ +--- +title: "theme options" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{theme options} + %\VignetteEncoding{UTF-8} + %\VignetteEngine{knitr::rmarkdown} +editor_options: + markdown: + wrap: 72 +--- + +```{=html} + +``` +This page aims to explain the options available in the theme category. It +will discuss the purpose of each argument, the possible values it can +take, and the expected outcome of each argument. + +#### animation_duration + +Specifies the duration of animations in the visualization, in +milliseconds. The default value is 0, indicating no animation. It +expects a value of type numeric (hdtype Num) in the range [0, 3000] +milliseconds. + +#### axis_line_color + +Specifies the color of the axis lines in a graphic. The default color is +`#7e858c`. It expects a value of type character (hdtype Clr). + +#### axis_line_size + +Controls the thickness of the axis lines in a graphic. A larger size +makes the axes more prominent, helping to emphasize them within the +visualization. The default value is NA, which means the size is not +explicitly set. It expects a value of type numeric (hdtype Num). + +#### axis_line_x_size + +Specifies the size or thickness of the X-axis line in a plot. The +default size is 0 and It expects a value of type numeric (hdtype Num). + +#### axis_line_y_size + +Specifies the size or thickness of the Y-axis line in a plot. The +default size is 1 and It expects a value of type numeric (hdtype Num). + +#### axis_margin_x + +Controls the margin on the X-axis of the graphic. Which is the space +between the edge of the chart area and the data points. A larger margin +provides breathing room for the data points, preventing them from +getting too close to the axis lines or the edge of the chart. The +default value is NULL and it expects a value of type numeric (hdtype +Num). + +#### axis_margin_y + +Controls the margin around the Y-axis in the graphic, which is the space +between the edge of the chart area and the data points along the Y-axis. +The default value is NA and it expects a value of type numeric (hdtype +Num). + +#### axis_show + +Controls the visibility of the axes in a graphic. By default, it is set +to FALSE, meaning the axes are not shown. It expects a logical value +(hdtype Chk). + +#### axis_tick_length + +Specifies the length of the tick marks along the axes of a chart. These +small lines help indicate specific values on the axes. The default +length is 10 and it expects a value of type numeric (hdtype Num). + +#### axis_ticks_color + +Determines the color of the tick marks along the axes of a chart. If +set, this color is applied to the small lines that indicate specific +values on the axes. The default value is NA and this argument expects a +value of type character (hdtype Clr). + +#### background_color + +Specifies the background color for the entire visualization. The default +color is #fafafa, which provides a neutral and clean background. It +expects a value of type character (hdtype Clr). + +#### bar_padding + +Specifies the spacing between bars in a bar chart. The default value is +0. This parameter can change the overall appearance of the chart, making +it more compact or more spaced out. It expects a numeric value (hdtype +Num). + +#### bar_width + +Specifies the width of the bars in a bar chart. Adjusting this parameter +can visually impact the chart's appearance, making it more compact or +more spaced out. The default value is 0 and it expects a numeric value +(hdtype Num). + +#### border_color + +Specifies the color of the border around the visualization. The default +value is NULL, indicating no border color is set. It expects a value of +type character (hdtype Clr). + +#### branding_background_color + +Specifies the background color for the area of the visualization +dedicated to the logo. The default value is NULL, but you can specify +the color using any valid format. It expects a value of type character +(hdtype Clr). + +#### branding_include + +Controls the presence of the logo in the visualization. By default, it +is set to FALSE, indicating that the logo is not included.It expects a +logical value (hdtype Chk), either TRUE or FALSE. + +#### branding_text + +Specifies the text used for the footer or logo space. By default, it is +set to "Created with Datasketch ". You can +customize this text to include your own branding or attribution +information. It expects a value of type character (hdtype Txt). + +#### caption + +Provide a descriptive or explanatory text that accompanies a +visualization, providing additional context such as the data source. It +expects a value of type character (hdtype Txt). + +#### caption_align + +Controls the alignment of the credits in the visualization. The default +alignment is "left" and it expects a value of type character (hdtype +Cat). + +#### caption_color + +Controls the color of the text for the credits in the visualization. The +default color is #28333f and it expects a value of type character +(hdtype Clr). + +#### caption_link + +Specify a link associated with the credits of the graph. It accepts +values of type character (hdtype Txt), where a valid URL can be provided +as a string. The default value is NULL. + +#### caption_margin + +Specifies the margin around the credits of the visualization. The +default value is 15 and its it expects a value of type numeric (hdtype +Num). + +#### caption_size + +Specifies the font size, in points, of the text in the credits of the +visualization. The default value is 12 and it expects a value of type +numeric (hdtype Num). + +#### caption_weight + +Specifies the font weight used for the credits in a visualization. A +higher weight corresponds to a bolder text. The default value is NULL +and it expects a value of type character (hdtype Cat). + +#### color_bins + +This option divides the data into categories based on color ranges. This +feature is particularly useful for creating heatmaps or graphs that +depend on the intensity of values. By default, it is set to NULL and it +expects a logical value (hdtype Chk). + +#### color_bins_method + +Determines how data is grouped into bins (intervals) based on their +values and assigned colors in graphs like heatmaps or histograms. Common +methods include "quantile," "equal," "k-means," and others, influencing +the distribution of data into color categories. The default value is +NULL, expecting a character value (hdtype Cat). + +#### color_palette_categorical + +Specifies the color palette used for categorical data where each +category is represented by a different color. This argument takes a list +of colors (hdtype Lst[Clr]) in any valid format. By default, it has the +value +`list(#385573, #ffa92a, #f06142, #99e8b3, #32a8ce, #996295, #e59fd7)`. + +#### color_palette_divergening + +Specifies the color palette used to represent diverging data, where +colors represent two opposite extremes or value ranges, such as +hot/cold, high/low, etc. The argument expects a list of colors (hdtype +Lst[Clr]) in any valid format. By default, it is set to `list(#ff844e,#ffa154, #ffc48b, #eef0f1, #a0c7da, #57a0c5, #255b89)`. + +#### color_palette_sequential + +Specifies the color palette used for sequential data, where every color +represent a sequence or gradient. Typically used to show intensity or +magnitude. It received a list of colors (hdtype Lst[Clr]) in any valid +format, its default value is +`list(#b8f3ca, #add79c, #8dbd93, #70a38e, #568989, #3f6f83, #28557d)`. + +#### datalabel_color + +Specifies the color of the text for data labels. By default, it is NULL +and it expects a value of type character (hdtype Clr). + +#### datalabel_format_sample + +Specifies the format of the data labels. By default, it is NULL and it +expects a value of type character (hdtype Txt). + +#### datalabel_formmater_js + +Specifies a JavaScript function to customize the format of the data +labels. By default, it is set to FALSE, indicating that no custom +formatting function is applied. This argument expects a logical value +(hdtype Chk). + +#### datalabel_horizontal_align + +Determines the horizontal alignment of the data labels in a graph. By +default, it is set to center, meaning the labels are centered +horizontally. This argument expects a character value (hdtype Cat), with +possible values of center, right, and left. + +#### datalabel_offset + +Specifies the offset of the data labels. It is used to adjust the +position of labels that display information about specific data points, +such as values or names. The default value is 0, which means no offset. +It expects a numeric value (hdtype Num). + +#### datalabel_offset_x + +Specifies the horizontal offset of data labels. This adjustment helps +prevent label overlap and enhances readability. The default value is +1.1, which provides a slight rightward shift to the labels. It expects a +numeric value (hdtype Num). + +#### datalabel_offset_y + +Adjusts the vertical position (Y-axis) of data labels in a graph, +helping to prevent text overlap. By default, this value is NULL, +allowing labels to be automatically positioned. It expects a numeric +value (hdtype Num). + +#### datalabel_size + +Specifies the font size of data labels in a graph. The default value is +NULL and it expects a numeric value (hdtype Num). + +#### datalabel_text_outline_show + +Turns the outline around the text of data labels on the chart on or off. +Enabling outline can improve readability against complex or similarly +colored backgrounds. By default, this feature is enabled (TRUE) and +expects a logical value (hdtype Chk). + +#### datalabel_vertical_align + +Specifies the vertical alignment of data labels in a chart. The default +alignment is center, meaning labels are centered vertically. Other +possible values include top and bottom, allowing labels to align at the +top or bottom of the associated data points. It expects a character +value (hdtype Cat). + +#### format_sample_cat + +Allows specifying how categorical data should be formatted, such as +whether to convert them to uppercase, lowercase, etc. It expects a +character value (hdtype Txt) and its default value is NULL, which means +no default formatting is applied. + +#### format_sample_dat + +Used to format date-type data and allows to specify how date-type data +should be formatted (for example YYYY-MM-DD or DD/MM/YYYY). It expects a +character value (hdtype Txt) and the default value is NULL, indicating +that no specific formatting is applied by default. + +#### format_sample_num + +Used to set the format for numbers in the visualization. If no format is +specified for axes, all numbers will use the format specified by this +argument. The default value is 1500 and this expects a value of type +character (hdtype Txt). + +#### grid_color + +Specifies the overall color of the grid lines in a graph. This parameter +can affect both the X and Y axis grid lines if individual colors are not +specified (grid_x_color, grid_y_color). The default color is #d1d9db, +which is a light gray. It expects a value of type character (hdtype +Clr). + +#### grid_line_type + +Specifies the line style for the grid in a graph, such as solid, dotted, +or dashed lines. The default style is "Dot" for dotted lines It expects +a character value (hdtype Cat), with options like "dot", "line", and +"dash". + +#### grid_size + +Specifies the general size of the grid lines in a graph. The default +size is 0.3. it expects a value of type numeric (hdtype Num). + +#### grid_x_color + +Determines the color of the grid lines corresponding to the X-axis in a +chart. This color is crucial for distinguishing the divisions or marks +along the X-axis. The default color is #d1d9db. it expects a value of +type character (hdtype Clr). + +#### grid_x_line_type + +Specifies the line type (solid, dashed, etc.) for the grid on the +X-axis. By default, this parameter is set to NULL. it expects a value of +type character (hdtype Cat). + +#### grid_x_show + +Determines whether the grid lines along the X-axis are displayed. When +set to TRUE, the grid lines are shown. The default value is TRUE and it +expects a value of type logical (hdtype Chk). + +#### grid_x_size + +Specifies the size of the grid lines associated with the X-axis in a +chart. A larger size makes the grid lines more noticeable. The default +value is 0, indicating that the grid lines are not visible. it expects a +value of type numeric (hdtype Num). + +#### grid_x_width + +Specifies the width of the grid lines corresponding to the X-axis in a +chart. The default value is 1, indicating a standard width for the grid +lines. It expects a value of type numeric (hdtype Num). + +#### grid_y_color + +Defines the color of the grid lines along the Y-axis in a chart. It +serves to differentiate the divisions or marks on the Y-axis. The +default color is #d1d9db. This argument expects a value of type +character (hdtype Clr) + +#### grid_y_line_type + +Determines the style of the grid lines along the Y-axis. It allows you +to specify whether the lines should be solid, dotted, dashed, or another +style. The default value is NULL, meaning the line style is not +explicitly set. This argument expects a value of type character (hdtype +Cat). + +#### grid_y_show + +Controls the visibility of the horizontal grid lines. When set to TRUE, +the grid lines along the Y-axis are displayed. If set to FALSE, the +horizontal grid lines will not be displayed. The default value is TRUE, +meaning the grid lines are shown. This argument expects a value of type +logical (hdtype Chk). + +#### grid_y_size + +Specifies the size of the horizontal grid lines (related to the Y-axis) +in a graphic. The default value is NULL and this argument expects a +value of type numeric (hdtype Num). + +#### grid_y_width + +Specifies the width of the grid lines corresponding to the Y-axis in a +chart. The default value is 1, which represents a standard width. This +argument expects a value of type numeric (hdtype Num). + +#### highlight_values_color + +Specifies the color used to highlight specific values or elements in the +visualization. The default color is #50c5b7, which is a shade of teal. +It expects a value of type character (hdtype Clr). + +#### legend_background + +Specifies the background color of the legend in the chart. The default +color is transparent and it expects a value of type character (hdtype +Clr). + +#### legend_border_width + +Specifies the width of the border around the legend. The default value +is 0, which means no border is displayed. Increasing the value will +increase the widht of the border. It expects a numeric value (hdtype +Num). + +#### legend_margin + +Specifies the width of the border around the legend in a visualization. +This affects the spacing between the legend and other elements of the +graph or the edges of the visualization. The default value is 0 and it +expects a value of type numeric (hdtype Num). + +#### legend_margin_bottom + +Specifies the margin at the bottom of the legend in a visualization. The +default value is NULL, meaning no specific bottom margin is applied. It +expects a value of type numeric (hdtype Num). + +#### legend_margin_left + +Specifies the margin to the left of the legend in a visualization. The +default value is NULL, meaning no specific left margin is applied. It +expects a value of type numeric (hdtype Num). + +#### legend_margin_right + +Specifies the margin to the right of the legend in a visualization. The +default value is NULL, meaning no specific right margin is applied. It +expects a value of type numeric (hdtype Num). + +#### legend_margin_top + +Adjusts the top margin of the legend in the chart. The default value is +NULL, meaning no specific top margin is applied. It expects a value of +type numeric (hdtype Num). + +#### legend_show + +Ccontrols the visibility of the legend in a chart. The default value is +TRUE, meaning the legend is visible. It expects a value of type logical +(hdtype Chk). + +#### legend_text_color + +Specifies the color of the text in the legend. By default, the color is +not explicitly set (NULL). It expects a value of type color (hdtype +Clr). + +#### legend_text_family + +Specifies the font family for the text in the legend. The default font +family is IBM Plex Sans, providing a clean and modern look for the +legend text. It expects a value of type character (hdtype Fnt). + +#### legend_text_horizontal_align + +Controls the horizontal alignment of the text within the legend box. The +default is center, which centers the text horizontally. Other possible +values include left and right. It expects a value of type character +(hdtype Cat). + +#### legend_text_margin + +Sets the margin around the text inside the legend. The default value +isNULL, indicating no specific margin is set. It expects a numeric value +(hdtype Num). + +#### legend_text_margin_bottom + +Defines the margin or space below the text of each item in the legend, +useful for controlling the spacing and arrangement of elements within +the legend. The default value is 0. It expects a value of type numeric +(hdtype Num). + +#### legend_text_margin_left + +Defines the margin to the left of the text within the legend, +controlling the spacing and alignment of the text inside the legend. Its +default value is NULL, and it expects a numeric value (hdtype Num). + +#### legend_text_margin_right + +Sets the margin to the right of the text within the legend, controlling +the spacing and alignment of the text inside the legend. Its default +value is NULL, and it expects a numeric value (hdtype Num). + +#### legend_text_margin_top + +Sets the margin or space at the top of the text within the legend, +controlling the spacing and alignment of the text inside the legend. Its +default value is 0, and it expects a numeric value (hdtype Num). + +#### legend_text_size + +Determines the size of the text inside the legend. Its default value is +11, and it expects a numeric value representing the size in points +(hdtype Num). + +#### legend_text_vertical_align + +Specifies the vertical alignment of the text within the legend. The +default value is center, which vertically centers the text. Other +possible values include top and bottom. It expects a value of type +character (hdtype Cat). + +#### line_color + +Allows for the customization of line colors in a graph. The default +color is #BEC7D0, a light gray shade. This parameter expects a value of +type character (hdtype Clr). + +#### line_marker + +Controls the visibility of markers in a line chart. When set to TRUE, +markers such as points, circles, or squares (as specified by +line_marker_type) are displayed along the lines. The default value is +FALSE, meaning that markers are not shown. This parameter expects a +logical value (hdtype Chk). + +#### line_marker_size + +Defines the size of markers in a line graph. Markers are small symbols +(such as circles, squares, triangles) placed at data points along the +line. The default size is 4. This parameter expects a numeric value +(hdtype Num). + +#### line_size + +Defines the thickness of the lines in a line chart.The default size is +0.5 and this parameter expects a numeric value (hdtype Num). + +#### locale + +Defines the regional settings that affect how data is presented, such as +date, currency, and number format. The default value is en-US, which +corresponds to English (United States). You can specify other locales to +format your data according to different regional conventions. This +parameter expects a character value (hdtype Cat). + +#### logo + +Specifies the PNG, SVG, or link of the logo to be added to the graph's +canvas. The default value is NULL, indicating that no logo is added. +This parameter expects a character type (hdtype Img). + +#### logo_height + +Specifies the height of the logo in the graph's canvas. The default +value is NULL, but you can provide a numeric value to set the height of +the logo in pixels. This parameter expects a numeric value (hdtype Num). + +#### logo_position + +Defines the position of the logo within the chart's canvas. The default +position is "right," indicating that the logo is placed on the right +side of the chart. You can specify a different position by providing one +of the following values: + +- topleft + +- topcenter + +- topright + +- centerleft + +- centercenter + +- centerright + +- bottomleft + +- bottomcenter + +- bottomright + +This parameter expects a character value (hdtype Cat). + +#### logo_width + +Defines the width of the logo in the graph. The default value is NULL, +which means that the width is not specify and the logo will be displayed +at its original size. You can specify a numeric value (hdtype Num) to +adjust the width of the logo. + +#### map_graticule + +Controls the display of a grid of lines (meridians and parallels) on a +map for geographic reference. When set to TRUE, the grid is displayed; +when set to FALSE, it is hidden. The default value is FALSE and this +parameter expects a logical value (hdtype Chk). + +#### map_graticule_interval + +Sets the interval between lines of the graticule on a map. These lines +typically represent meridians and parallels to aid in geographic +orientation. The default value is 5, meaning that lines are drawn every +5 degrees. This parameter expects a numeric value (hdtype Num) +representing the interval in degrees. + +#### map_provider_tile + +Specifies the tile provider used for map backgrounds. The default value +is "leaflet" and expects a value of type character (hdtype Cat) +representing the tile provider's name. + +#### plot_background_color + +Defines the background color of the plot area in a graph. The default +value is NA, meaning no specific color is set. This parameter expects a +value of type character (hdtype Clr) representing a color. + +#### plot_border_color + +Defines the color of the border around the main plot area in a chart. +The default color is #d1d9d, light gray color. This parameter expects a +value of type character (hdtype Clr). + +#### plot_border_width + +Determines the width of the border around the main plot area in a chart. +The default width is 1 and expects a value of type numeric (hdtype Num). + +#### plot_margin_bottom + +Controls the margin at the bottom of the plot area. It affects the space +between the plot area and other elements of the chart or the edges of +the visualization. The default value is NULL and expects a value of type +numeric (hdtype Num). + +#### plot_margin_left + +Controls the margin on the left side of the plot area. It affects the +space between the plot area and other elements of the chart or the edges +of the visualization. The default value is NULL and expects a value of +type numeric (hdtype Num). + +#### plot_margin_right + +Controls the margin on the right side of the plot area. Adjusting this +margin can be useful to ensure that all elements of the chart are +visible and not cramped. The default value is NA, expects a value of +type numeric (hdtype Num). + +#### plot_margin_top + +Controls the margin at the top of the plot area. The default value is +10, providing a margin of 10 units. This parameter expects a value of +type numeric (hdtype Num). + +#### subtitle_align + +Determines the alignment of the subtitle in the visualization. The +default alignment is left and its type is character (hdtype Cat), +meaning it accepts values such as "left", "center", or "right". + +#### subtitle_color + +Defines the color of the subtitle text in the visualization. You can +specify the color using any valid format. The default color is #28333f +and its type is character (hdtype Clr). + +#### subtitle_size + +Specifies the font size, in points, of the subtitle text in the +visualization. The default size is 17 points and it expects a value of +type numeric (hdtype Num). + +#### subtitle_weight + +Specifies the font weight of the subtitle text in the visualization.The +default weight is 700, and its type is character (hdtype Cat). + +#### table_table_background+ + +Defines the background color for the entire table. The default color is #ffffff, which corresponds to white. You can change this value to +customize the background color of the table. This parameter expects a +color value (hdtype Clr). + +#### text_color + +Specifies the general text color in the visualization. The default color +is #28333f, which is a dark blue-gray. You can change this value to +customize the text color throughout the visualization. This parameter +expects a color value (hdtype Clr). + +#### text_size + +Specifies the general text size in the visualization. The default size +is 12, but you can adjust this value to make the text larger or smaller +throughout the visualization. This parameter expects a numeric value +(hdtype Num). + +#### text_wrap + +Determines the maximum number of characters that can appear in a single +line of text in the visualization. If a text string exceeds this limit, +it will wrap onto the next line. The default value is 12, meaning that +text will wrap after 12 characters. This parameter expects a numeric +value (hdtype Num). + +#### title_align + +Controls the alignment of the title within the visualization. By +default, the title is aligned to the left, but you can adjust it to be +centered or aligned to the right. it expects a value of type numeric +(hdtype Cat). + +#### title_axis_color + +Specifies the color of the text used for the axis titles in a chart. +This helps distinguish the axis titles from other text in the +visualization. The default value is NULL, indicating that the color is +not explicitly set. It expects a value of type character (hdtype Clr). + +#### title_axis_size + +Defines the font size for the axis titles in a graphic. The default size +is 13 points, and you can specify values from 1 to 20 points. Its type +is numeric (hdtype Num). + +#### title_color + +Specifies the color of the text used for the main title in a +visualization. The default color is #28333f and it expects a value of +type character(hdtype Clr). + +#### title_family + +Specifies the font family used for the main title in a visualization. +The default font family is IBM Plex Sans and it expects a value of type +character(hdtype Fnt). + +#### title_size + +Determines the font size of the visualization's title. The default size +is 21 points but you can adjust this value from 1 to 20 points. It +expects a value of type numeric (hdtype Num). + +#### title_weight + +Specifies the font weight of the visualization's title. The default +weight is 700 (bold style), but you can choose between several options +such as thin, light, regular, medium, bold, and black. It expects a +value of type character (hdtype Cat). + +#### tooltip_background + +Defines the background color of tooltips that provide additional information when hovering over elements in the visualization. The default color is #ffffff (white), but you can customize this color to fit the style of the visualization. This parameter expects a color value (hdtype Clr). + +#### tooltip_text_family + +Defines the font family used for the text inside tooltips. The default is NULL, which means the default font will be used. You can specify a font family from the available fonts list to customize the appearance of the tooltips. This parameter expects a character value (hdtype Fnt). + +#### tooltip_text_size + +Sets the font size for the text inside tooltips. The default size is 14 points, but you can specify a size between 1 and 20 points to adjust the text size in the tooltips. This parameter expects a numeric value representing the font size (hdtype Num). + +#### x_max + +Sets the maximum value for the X-axis in a chart. It determines the upper limit of the X-axis, controlling the range of data displayed along this axis. The default value is NULL and expects a numeric value (hdtype Num). + +#### x_min + +Sets the minimum value for the X-axis in a chart. It determines the lower limit of the X-axis, controlling the range of data displayed along this axis. The default value is NULL and expects a numeric value (hdtype Num). + +#### y_axis_align + +Specifies the alignment of the Y-axis labels in a chart. It can be set to "left", "right", or "center" relative to the axis. The default value is NULL, which means that the alignment is determined automatically and expects a character values (hdtype Cat). + +#### y_max + +Set the maximum value represented on the Y-axis of a chart. This parameter allows you to focus the visualization on a specific range of interest by defining the upper limit of the Y-axis. The default value is NULL and it expects a numerical value (hdtype Num). + +#### y_min + +Sets the minimum value for the Y-axis in a chart. It determines the lower limit of the Y-axis, controlling the range of data displayed along this axis. The default value is NULL and it expects a numeric value (hdtype Num). diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/92992C5E b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/92992C5E new file mode 100644 index 0000000..e35392c --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/92992C5E @@ -0,0 +1,26 @@ +{ + "id": "92992C5E", + "path": "~/Nicolas_Datasktch/dsopts/vignettes/titles_options.Rmd", + "project_path": "vignettes/titles_options.Rmd", + "type": "r_markdown", + "hash": "0", + "contents": "", + "dirty": false, + "created": 1708534497775.0, + "source_on_save": true, + "relative_order": 6, + "properties": { + "source_window_id": "", + "Source": "Source", + "cursorPosition": "127,151", + "scrollLine": "0" + }, + "folds": "", + "lastKnownWriteTime": 1708716730, + "encoding": "UTF-8", + "collab_server": "", + "source_window": "", + "last_content_update": 1708716730307, + "read_only": false, + "read_only_alternatives": [] +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/92992C5E-contents b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/92992C5E-contents new file mode 100644 index 0000000..44b9cff --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/92992C5E-contents @@ -0,0 +1,140 @@ +--- +title: "titles options" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{titles options} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + + +This page aims to explain the options available in the titles category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. + +#### caption + +Provide a descriptive or explanatory text that accompanies a visualization, providing additional context such as the data source. It expects a value of type character (hdtype Txt). + +#### caption_align + +Controls the alignment of the credits in the visualization. The default alignment is "left" and it expects a value of type character (hdtype Cat). + +#### caption_color + +Controls the color of the text for the credits in the visualization. The default color is #28333f and it expects a value of type character (hdtype Clr). + +#### caption_link + +Specify a link associated with the credits of the graph. It accepts values of type character (hdtype Txt), where a valid URL can be provided as a string. The default value is NULL. + +#### caption_margin + +Specifies the margin around the credits of the visualization. The default value is 15 and its it expects a value of type numeric (hdtype Num). + +#### caption_size + +Specifies the font size, in points, of the text in the credits of the visualization. The default value is 12 and it expects a value of type numeric (hdtype Num). + +#### caption_weight + +Specifies the font weight used for the credits in a visualization. A higher weight corresponds to a bolder text. The default value is NULL and it expects a value of type character (hdtype Cat). + +#### subtitle + +Defines secondary text that offers additional information or context about the visualization, typically positioned below the main title and it expects a value of type character (hdtype Txt). + +#### subtitle_align + +Determines the alignment of the subtitle in the visualization. The default alignment is left and its type is character (hdtype Cat), meaning it accepts values such as "left", "center", or "right". + +#### subtitle_color + +Defines the color of the subtitle text in the visualization. You can specify the color using any valid format. The default color is #28333f and its type is character (hdtype Clr). + +#### subtitle_size + +Specifies the font size, in points, of the subtitle text in the visualization. The default size is 17 points and it expects a value of type numeric (hdtype Num). + +#### subtitle_weight + +Specifies the font weight of the subtitle text in the visualization.The default weight is 700, and its type is character (hdtype Cat). + +#### title + +Defines the main title of the visualization, it accepts characters values(hdtype Txt). + +#### title_align + +Controls the alignment of the title within the visualization. By default, the title is aligned to the left, but you can adjust it to be centered or aligned to the right. it expects a value of type numeric (hdtype Cat). + +#### title_axis_color + +Specifies the color of the text used for the axis titles in a chart. This helps distinguish the axis titles from other text in the visualization. The default value is NULL, indicating that the color is not explicitly set. It expects a value of type character (hdtype Clr). + +#### title_axis_size + +Defines the font size for the axis titles in a graphic. The default size is 13 points, and you can specify values from 1 to 20 points. Its type is numeric (hdtype Num). + +#### title_color + +Specifies the color of the text used for the main title in a visualization. The default color is #28333f and it expects a value of type character(hdtype Clr). + +#### title_family + +Specifies the font family used for the main title in a visualization. The default font family is IBM Plex Sans and it expects a value of type character(hdtype Fnt). + +#### title_legend + +Defines the title for the legend in the visualization. The legend helps viewers to identify the meaning of each color, shape, or symbol used in the chart. Its type is character (hdtype Txt). + +#### title_size + +Determines the font size of the visualization's title. The default size is 21 points but you can adjust this value from 1 to 20 points. It expects a value of type numeric (hdtype Num). + +#### title_weight + +Specifies the font weight of the visualization's title. The default weight is 700 (bold style), but you can choose between several options such as thin, light, regular, medium, bold, and black. It expects a value of type character (hdtype Cat). diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/DD75D4B4 b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/DD75D4B4 new file mode 100644 index 0000000..f684d1f --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/DD75D4B4 @@ -0,0 +1,26 @@ +{ + "id": "DD75D4B4", + "path": "~/Nicolas_Datasktch/dsopts/vignettes/colorprep_options.Rmd", + "project_path": "vignettes/colorprep_options.Rmd", + "type": "r_markdown", + "hash": "0", + "contents": "", + "dirty": false, + "created": 1708534646191.0, + "source_on_save": true, + "relative_order": 2, + "properties": { + "source_window_id": "", + "Source": "Source", + "cursorPosition": "56,196", + "scrollLine": "0" + }, + "folds": "", + "lastKnownWriteTime": 1708716724, + "encoding": "UTF-8", + "collab_server": "", + "source_window": "", + "last_content_update": 1708716724112, + "read_only": false, + "read_only_alternatives": [] +} \ No newline at end of file diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/DD75D4B4-contents b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/DD75D4B4-contents new file mode 100644 index 0000000..920429f --- /dev/null +++ b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/DD75D4B4-contents @@ -0,0 +1,85 @@ +--- +title: "colorprep options" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{colorprep options} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + + + +This page aims to explain the options available in the colorprep category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. + +#### color_by + +Specifies the variable used to color elements in a visualization. It determines how elements are colored based on different categories or groups. When set to NULL, a default color scale is often applied, and expects a character value (hdtype Txt) representing the variable name. + +#### color_palette_categorical + +Specifies the color palette used for categorical data where each category is represented by a different color. This argument takes a list of colors (hdtype Lst[Clr]) in any valid format. By default, it has the value `list(#385573, #ffa92a, #f06142, #99e8b3, #32a8ce, #996295, #e59fd7)`. + +#### color_palette_divergening + +Specifies the color palette used to represent diverging data, where colors represent two opposite extremes or value ranges, such as hot/cold, high/low, etc. The argument expects a list of colors (hdtype Lst[Clr]) in any valid format. By default, it is set to list(#ff844e, #ffa154, #ffc48b, #eef0f1, #a0c7da, #57a0c5, #255b89). + +#### color_palette_sequential + +Specifies the color palette used for sequential data, where every color represent a sequence or gradient. Typically used to show intensity or magnitude. It received a list of colors (hdtype Lst[Clr]) in any valid format, its default value is `list(#b8f3ca, #add79c, #8dbd93, #70a38e, #568989, #3f6f83, #28557d)`. + +#### color_palette_type + +Specifies the type of color palette to be used in the visualization. It defaults to NULL and its possible values include "categorical," "sequential," and "diverging" (hdtype Cat). + +#### highlight_values_color + +Specifies the color used to highlight specific values or elements in the visualization. The default color is #50c5b7, and it expects a value of type character (hdtype Clr), which can be specified in any valid color format. + +#### na_color + +Specifies the color used to represent missing or "NA" (Not Available) data. The default color is #cbcdcf, and it expects a value of type character (hdtype Clr), which can be specified in any valid color format. diff --git a/.Rproj.user/F19CAEE1/sources/session-7e2f6534/lock_file b/.Rproj.user/F19CAEE1/sources/session-7e2f6534/lock_file new file mode 100644 index 0000000..e69de29 diff --git a/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE169552a7f/chunks.json b/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE169552a7f/chunks.json new file mode 100644 index 0000000..839c3b7 --- /dev/null +++ b/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE169552a7f/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708545449} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE1b1dc2917/chunks.json b/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE1b1dc2917/chunks.json new file mode 100644 index 0000000..08d510a --- /dev/null +++ b/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE1b1dc2917/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708715157} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE1fa0c1ccd/chunks.json b/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE1fa0c1ccd/chunks.json new file mode 100644 index 0000000..43ccf70 --- /dev/null +++ b/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/F19CAEE1fa0c1ccd/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708524440} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/s/chunks.json b/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/s/chunks.json new file mode 100644 index 0000000..08d510a --- /dev/null +++ b/.Rproj.user/shared/notebooks/4242E0A5-axis_options/1/s/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708715157} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/F19CAEE1b1dc2917/chunks.json b/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/F19CAEE1b1dc2917/chunks.json new file mode 100644 index 0000000..870b3ab --- /dev/null +++ b/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/F19CAEE1b1dc2917/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708545548} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/F19CAEE1fa0c1ccd/chunks.json b/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/F19CAEE1fa0c1ccd/chunks.json new file mode 100644 index 0000000..eaa213a --- /dev/null +++ b/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/F19CAEE1fa0c1ccd/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708459428} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/s/chunks.json b/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/s/chunks.json new file mode 100644 index 0000000..870b3ab --- /dev/null +++ b/.Rproj.user/shared/notebooks/4CB42059-dataprep_options/1/s/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708545548} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/F19CAEE1b1dc2917/chunks.json b/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/F19CAEE1b1dc2917/chunks.json new file mode 100644 index 0000000..5767bf4 --- /dev/null +++ b/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/F19CAEE1b1dc2917/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708547322} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/F19CAEE1ee8ca85e/chunks.json b/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/F19CAEE1ee8ca85e/chunks.json new file mode 100644 index 0000000..5fb43ef --- /dev/null +++ b/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/F19CAEE1ee8ca85e/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708527231} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/s/chunks.json b/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/s/chunks.json new file mode 100644 index 0000000..5767bf4 --- /dev/null +++ b/.Rproj.user/shared/notebooks/501C4D03-colorprep_options/1/s/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708547322} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1534a38c9/chunks.json b/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1534a38c9/chunks.json deleted file mode 100644 index 0bc3af3..0000000 --- a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1534a38c9/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708113413} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE19aec1e8d/chunks.json b/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE19aec1e8d/chunks.json deleted file mode 100644 index 1c0f5f7..0000000 --- a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE19aec1e8d/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708024752} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1b1014c77/chunks.json b/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1b1014c77/chunks.json deleted file mode 100644 index e415b33..0000000 --- a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1b1014c77/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708363616} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1ba527cb1/chunks.json b/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1ba527cb1/chunks.json deleted file mode 100644 index c15953b..0000000 --- a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1ba527cb1/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708122275} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1f8097f71/chunks.json b/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1f8097f71/chunks.json deleted file mode 100644 index 333f42c..0000000 --- a/.Rproj.user/shared/notebooks/69878433-argui/1/F19CAEE1f8097f71/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708356294} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/69878433-argui/1/s/chunks.json b/.Rproj.user/shared/notebooks/69878433-argui/1/s/chunks.json deleted file mode 100644 index e415b33..0000000 --- a/.Rproj.user/shared/notebooks/69878433-argui/1/s/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708363616} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/F19CAEE1b1dc2917/chunks.json b/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/F19CAEE1b1dc2917/chunks.json new file mode 100644 index 0000000..92b80ea --- /dev/null +++ b/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/F19CAEE1b1dc2917/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708545469} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/F19CAEE1ee8ca85e/chunks.json b/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/F19CAEE1ee8ca85e/chunks.json new file mode 100644 index 0000000..e591c67 --- /dev/null +++ b/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/F19CAEE1ee8ca85e/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708534537} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/s/chunks.json b/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/s/chunks.json new file mode 100644 index 0000000..92b80ea --- /dev/null +++ b/.Rproj.user/shared/notebooks/6E077AAB-titles_options/1/s/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708545469} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/74437666-index_categories/1/F19CAEE1b1014c77/chunks.json b/.Rproj.user/shared/notebooks/74437666-index_categories/1/F19CAEE1b1014c77/chunks.json deleted file mode 100644 index 91a3f20..0000000 --- a/.Rproj.user/shared/notebooks/74437666-index_categories/1/F19CAEE1b1014c77/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[{"row":61,"row_count":1,"visible":true,"expansion_state":0,"options":{"engine":"r","label":"setup","include":false,"dev":"png"},"document_id":"E219DC33","chunk_id":"csetup_chunk","chunk_label":"setup"}],"doc_write_time":1708365249} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/74437666-index_categories/1/s/chunks.json b/.Rproj.user/shared/notebooks/74437666-index_categories/1/s/chunks.json deleted file mode 100644 index 91a3f20..0000000 --- a/.Rproj.user/shared/notebooks/74437666-index_categories/1/s/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[{"row":61,"row_count":1,"visible":true,"expansion_state":0,"options":{"engine":"r","label":"setup","include":false,"dev":"png"},"document_id":"E219DC33","chunk_id":"csetup_chunk","chunk_label":"setup"}],"doc_write_time":1708365249} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/74437666-index_categories/1/s/csetup_chunk/00000f.csv b/.Rproj.user/shared/notebooks/74437666-index_categories/1/s/csetup_chunk/00000f.csv deleted file mode 100644 index 56c8fe6..0000000 --- a/.Rproj.user/shared/notebooks/74437666-index_categories/1/s/csetup_chunk/00000f.csv +++ /dev/null @@ -1,4 +0,0 @@ -"0","knitr::opts_chunk$set(" -"0"," collapse = TRUE," -"0"," comment = ""#>""" -"0",")" diff --git a/.Rproj.user/shared/notebooks/79E78B7C-colors/1/s/chunks.json b/.Rproj.user/shared/notebooks/79E78B7C-colors/1/s/chunks.json deleted file mode 100644 index ccea483..0000000 --- a/.Rproj.user/shared/notebooks/79E78B7C-colors/1/s/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708358886} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/9BB26216-titles/1/s/chunks.json b/.Rproj.user/shared/notebooks/9BB26216-titles/1/s/chunks.json deleted file mode 100644 index c356441..0000000 --- a/.Rproj.user/shared/notebooks/9BB26216-titles/1/s/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708358912} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1534a38c9/chunks.json b/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1534a38c9/chunks.json deleted file mode 100644 index 7a2de56..0000000 --- a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1534a38c9/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708111512} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1b1014c77/chunks.json b/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1b1014c77/chunks.json deleted file mode 100644 index e6b0ce5..0000000 --- a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1b1014c77/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[{"row":61,"row_count":1,"visible":true,"expansion_state":0,"options":{"engine":"r","label":"setup","include":false,"dev":"png"},"document_id":"E219DC33","chunk_id":"csetup_chunk","chunk_label":"setup"}],"doc_write_time":1708363636} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1ba527cb1/chunks.json b/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1ba527cb1/chunks.json deleted file mode 100644 index 256d19e..0000000 --- a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1ba527cb1/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[{"row":61,"row_count":1,"visible":true,"expansion_state":0,"options":{"engine":"r","label":"setup","include":false,"dev":"png"},"document_id":"E219DC33","chunk_id":"csetup_chunk","chunk_label":"setup"}],"doc_write_time":1708355917,"working_dir":null,"default_chunk_options":{"collapse":true,"comment":"#>"}} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1f8097f71/chunks.json b/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1f8097f71/chunks.json deleted file mode 100644 index af94895..0000000 --- a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/F19CAEE1f8097f71/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[{"row":61,"row_count":1,"visible":true,"expansion_state":0,"options":{"engine":"r","label":"setup","include":false,"dev":"png"},"document_id":"E219DC33","chunk_id":"csetup_chunk","chunk_label":"setup"}],"doc_write_time":1708359212} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/s/chunks.json b/.Rproj.user/shared/notebooks/A697761D-indexcat/1/s/chunks.json deleted file mode 100644 index e6b0ce5..0000000 --- a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/s/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[{"row":61,"row_count":1,"visible":true,"expansion_state":0,"options":{"engine":"r","label":"setup","include":false,"dev":"png"},"document_id":"E219DC33","chunk_id":"csetup_chunk","chunk_label":"setup"}],"doc_write_time":1708363636} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/s/csetup_chunk/00000f.csv b/.Rproj.user/shared/notebooks/A697761D-indexcat/1/s/csetup_chunk/00000f.csv deleted file mode 100644 index 56c8fe6..0000000 --- a/.Rproj.user/shared/notebooks/A697761D-indexcat/1/s/csetup_chunk/00000f.csv +++ /dev/null @@ -1,4 +0,0 @@ -"0","knitr::opts_chunk$set(" -"0"," collapse = TRUE," -"0"," comment = ""#>""" -"0",")" diff --git a/.Rproj.user/shared/notebooks/AFF4C85A-dataprep_options/1/F19CAEE1b1014c77/chunks.json b/.Rproj.user/shared/notebooks/AFF4C85A-dataprep_options/1/F19CAEE1b1014c77/chunks.json deleted file mode 100644 index abe5f6e..0000000 --- a/.Rproj.user/shared/notebooks/AFF4C85A-dataprep_options/1/F19CAEE1b1014c77/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708365190} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/AFF4C85A-dataprep_options/1/s/chunks.json b/.Rproj.user/shared/notebooks/AFF4C85A-dataprep_options/1/s/chunks.json deleted file mode 100644 index abe5f6e..0000000 --- a/.Rproj.user/shared/notebooks/AFF4C85A-dataprep_options/1/s/chunks.json +++ /dev/null @@ -1 +0,0 @@ -{"chunk_definitions":[],"doc_write_time":1708365190} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE169552a7f/chunks.json b/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE169552a7f/chunks.json new file mode 100644 index 0000000..7ebb8f7 --- /dev/null +++ b/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE169552a7f/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708715352} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE1b1dc2917/chunks.json b/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE1b1dc2917/chunks.json new file mode 100644 index 0000000..8fe280a --- /dev/null +++ b/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE1b1dc2917/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708715380} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE1fa0c1ccd/chunks.json b/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE1fa0c1ccd/chunks.json new file mode 100644 index 0000000..a131189 --- /dev/null +++ b/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/F19CAEE1fa0c1ccd/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708523596} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/s/chunks.json b/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/s/chunks.json new file mode 100644 index 0000000..8fe280a --- /dev/null +++ b/.Rproj.user/shared/notebooks/BE5766B4-index_categories/1/s/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708715380} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE169552a7f/chunks.json b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE169552a7f/chunks.json new file mode 100644 index 0000000..b31c0ff --- /dev/null +++ b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE169552a7f/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708694376} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE185eadfe5/chunks.json b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE185eadfe5/chunks.json new file mode 100644 index 0000000..2744894 --- /dev/null +++ b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE185eadfe5/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708621340} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1b1dc2917/chunks.json b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1b1dc2917/chunks.json new file mode 100644 index 0000000..1fb7e59 --- /dev/null +++ b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1b1dc2917/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708711232} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1c73d173/chunks.json b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1c73d173/chunks.json new file mode 100644 index 0000000..aba9a51 --- /dev/null +++ b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1c73d173/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708608033} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1ee8ca85e/chunks.json b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1ee8ca85e/chunks.json new file mode 100644 index 0000000..7505261 --- /dev/null +++ b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/F19CAEE1ee8ca85e/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708543297} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/s/chunks.json b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/s/chunks.json new file mode 100644 index 0000000..1fb7e59 --- /dev/null +++ b/.Rproj.user/shared/notebooks/C7E2FF7F-theme_options/1/s/chunks.json @@ -0,0 +1 @@ +{"chunk_definitions":[],"doc_write_time":1708711232} \ No newline at end of file diff --git a/.Rproj.user/shared/notebooks/paths b/.Rproj.user/shared/notebooks/paths index e69de29..ca3dd81 100644 --- a/.Rproj.user/shared/notebooks/paths +++ b/.Rproj.user/shared/notebooks/paths @@ -0,0 +1,7 @@ +C:/Users/edda/Documents/Nicolas_Datasktch/dsopts/_pkgdown.yml="9478AFEF" +C:/Users/edda/Documents/Nicolas_Datasktch/dsopts/vignettes/axis_options.Rmd="4242E0A5" +C:/Users/edda/Documents/Nicolas_Datasktch/dsopts/vignettes/colorprep_options.Rmd="501C4D03" +C:/Users/edda/Documents/Nicolas_Datasktch/dsopts/vignettes/dataprep_options.Rmd="4CB42059" +C:/Users/edda/Documents/Nicolas_Datasktch/dsopts/vignettes/index_categories.Rmd="BE5766B4" +C:/Users/edda/Documents/Nicolas_Datasktch/dsopts/vignettes/theme_options.Rmd="C7E2FF7F" +C:/Users/edda/Documents/Nicolas_Datasktch/dsopts/vignettes/titles_options.Rmd="6E077AAB" diff --git a/docs/404.html b/docs/404.html index 3cd4c51..2e9f284 100644 --- a/docs/404.html +++ b/docs/404.html @@ -37,7 +37,7 @@ Reference
+ + + + +
+
+ + + + +

This page aims to explain the options available in the axis category. +It will discuss the purpose of each argument, the possible values it can +take, and the expected outcome of each argument.

+
+

axis_flip +

+

Swaps the X and Y axes in a plot. By default, it is set to FALSE, +meaning the axes are not flipped. When set to TRUE, the orientation of +the plot changes. This argument expects a logical values (hdtype +Chk).

+
+
+

axis_line_x_size +

+

Specifies the size or thickness of the X-axis line in a plot. The +default size is 0 and It expects a value of type numeric (hdtype +Num).

+
+
+

axis_reversed +

+

Reverses the axes of the plot, such as flipping the Y-axis so that +higher values appear at the bottom.The default value is FALSE, meaning +the axes are not reversed. Its value type is logical (hdtype Chk), with +possible values of TRUE or FALSE.

+
+
+

axis_text_angle +

+

Specifies the angle of the axis text in a graphic. This can help +improve readability when there are many labels or when labels are long. +The default angle is 0 degrees, which means the text is horizontal.You +can specify an angle between -90 and 90 degrees to rotate the text. It +expects a value of type numeric (hdtype Num).

+
+
+

axis_text_wrap +

+

Specifies the number of words to wrap in axis labels before wrapping +onto the next line. By default, it is set to 6, so axis labels will wrap +to the next line after 6 words. This allows long labels to be displayed +on multiple lines, improving readability. It expects a value of type +numeric (hdtype Num).

+
+
+

axis_x_reversed +

+

Reverses the order of the data on the X-axis of a chart. When set to +True, the highest values appear on the left and the lowest values on the +right. It expects a value of type logical (hdtype Chk).

+
+
+

axis_x_text_angle +

+

Specifies the angle of the labels on the X-axis in a chart.The +default value is NULL, which means no rotation is applied. Also, you can +specify an angle between -90 and 90 degrees to rotate the text. It +expects a value of type numeric (hdtype Num).

+
+
+

axis_x_text_wrap +

+

Specifies the number of words in the labels on the X-axis in a chart. +This allows long labels to be displayed on multiple lines and avoids +text overlap. The default value is NULL, indicating that no word +wrapping is applied. It expects a value of type numeric (hdtype +Num).

+
+
+

axis_y_reversed +

+

Inverts the axes of the chart (e.g., reverses the Y-axis so that +higher values are closer to the origin). If the chart is flipped, the +X-axis is reversed by default and means that the order of the data on +the Y-axis is reversed. The default value is FALSE, indicating that the +axes are not reversed. It expects a value of type logical (hdtype +Chk).

+
+
+

axis_y_text_angle +

+

Controls the angle of the labels on the Y-axis. The default value is +NULL, which means no rotation is applied. The angle can range from -90 +to 90 degrees. It expects a value of type numeric (hdtype Num).

+
+
+

axis_y_text_wrap +

+

Specifies the number of words in the labels of the Y-axis in a chart. +This parameter allows long labels to be displayed on multiple lines, +preventing text overlap. The default value is NULL, indicating that no +word wrapping is applied. It expects a value of type numeric (hdtype +Num).

+
+
+

title_axis_color +

+

Specifies the color of the text used for the axis titles in a chart. +This helps distinguish the axis titles from other text in the +visualization. The default value is NULL, indicating that the color is +not explicitly set. It expects a value of type character (hdtype +Clr).

+
+
+

title_axis_size +

+

Defines the font size for the axis titles in a graphic. The default +size is 13 points, and you can specify values from 1 to 20 points. It +expects a value of type numeric (hdtype Num).

+
+
+

title_axis_x +

+

Specifies the title for the X-axis of a chart, describing the +variable or data represented on the horizontal axis. It expects a value +of type character (hdtype Txt).

+
+
+

title_axis_y +

+

Specifies the title for the Y-axis of a chart, describing the +variable or data represented on the vertical axis. It expects a value of +type character (hdtype Txt).

+
+
+

title_axis_y2 +

+

Specifies the title for the secondary Y-axis in a chart. In charts +with two Y-axes, each axis can represent different types of data or +scales, and this title would help identify the nature of the data +represented by the secondary Y-axis. The default value is NULL and the +argument expects a value of type character (hdtype Txt).

+
+
+
+ + + +
+ + + +
+
+ + + + + + + diff --git a/docs/articles/colorprep_options.html b/docs/articles/colorprep_options.html new file mode 100644 index 0000000..5d88ba7 --- /dev/null +++ b/docs/articles/colorprep_options.html @@ -0,0 +1,202 @@ + + + + + + + + +colorprep options • dsopts + + + + + + + + + + Skip to contents + + +
+ + + + +
+
+ + + + +

This page aims to explain the options available in the colorprep +category. It will discuss the purpose of each argument, the possible +values it can take, and the expected outcome of each argument.

+
+

color_by +

+

Specifies the variable used to color elements in a visualization. It +determines how elements are colored based on different categories or +groups. When set to NULL, a default color scale is often applied, and +expects a character value (hdtype Txt) representing the variable +name.

+
+
+

color_palette_categorical +

+

Specifies the color palette used for categorical data where each +category is represented by a different color. This argument takes a list +of colors (hdtype Lst[Clr]) in any valid format. By default, it has the +value +list(#385573, #ffa92a, #f06142, #99e8b3, #32a8ce, #996295, #e59fd7).

+
+
+

color_palette_divergening +

+

Specifies the color palette used to represent diverging data, where +colors represent two opposite extremes or value ranges, such as +hot/cold, high/low, etc. The argument expects a list of colors (hdtype +Lst[Clr]) in any valid format. By default, it is set to list(#ff844e, +#ffa154, #ffc48b, #eef0f1, #a0c7da, #57a0c5, #255b89).

+
+
+

color_palette_sequential +

+

Specifies the color palette used for sequential data, where every +color represent a sequence or gradient. Typically used to show intensity +or magnitude. It received a list of colors (hdtype Lst[Clr]) in any +valid format, its default value is +list(#b8f3ca, #add79c, #8dbd93, #70a38e, #568989, #3f6f83, #28557d).

+
+
+

color_palette_type +

+

Specifies the type of color palette to be used in the visualization. +It defaults to NULL and its possible values include “categorical,” +“sequential,” and “diverging” (hdtype Cat).

+
+
+

highlight_values_color +

+

Specifies the color used to highlight specific values or elements in +the visualization. The default color is #50c5b7, and it expects a value +of type character (hdtype Clr), which can be specified in any valid +color format.

+
+
+

na_color +

+

Specifies the color used to represent missing or “NA” (Not Available) +data. The default color is #cbcdcf, and it expects a value of type +character (hdtype Clr), which can be specified in any valid color +format.

+
+
+
+ + + +
+ + + +
+
+ + + + + + + diff --git a/docs/articles/argui.html b/docs/articles/dataprep_options.html similarity index 75% rename from docs/articles/argui.html rename to docs/articles/dataprep_options.html index 5b57f0f..dfde0d1 100644 --- a/docs/articles/argui.html +++ b/docs/articles/dataprep_options.html @@ -39,7 +39,7 @@ Reference @@ -41,9 +41,17 @@

All vignettes

-
dataprep options
+
axis options
-
All categories
+
colorprep options
+
+
dataprep options
+
+
All categories
+
+
theme options
+
+
titles options
diff --git a/docs/articles/indexcat.html b/docs/articles/index_categories.html similarity index 93% rename from docs/articles/indexcat.html rename to docs/articles/index_categories.html index 793f390..a82886b 100644 --- a/docs/articles/indexcat.html +++ b/docs/articles/index_categories.html @@ -39,7 +39,7 @@ Reference
+ + + + +
+
+ + + + +

This page aims to explain the options available in the theme +category. It will discuss the purpose of each argument, the possible +values it can take, and the expected outcome of each argument.

+
+

animation_duration +

+

Specifies the duration of animations in the visualization, in +milliseconds. The default value is 0, indicating no animation. It +expects a value of type numeric (hdtype Num) in the range [0, 3000] +milliseconds.

+
+
+

axis_line_color +

+

Specifies the color of the axis lines in a graphic. The default color +is #7e858c. It expects a value of type character (hdtype +Clr).

+
+
+

axis_line_size +

+

Controls the thickness of the axis lines in a graphic. A larger size +makes the axes more prominent, helping to emphasize them within the +visualization. The default value is NA, which means the size is not +explicitly set. It expects a value of type numeric (hdtype Num).

+
+
+

axis_line_x_size +

+

Specifies the size or thickness of the X-axis line in a plot. The +default size is 0 and It expects a value of type numeric (hdtype +Num).

+
+
+

axis_line_y_size +

+

Specifies the size or thickness of the Y-axis line in a plot. The +default size is 1 and It expects a value of type numeric (hdtype +Num).

+
+
+

axis_margin_x +

+

Controls the margin on the X-axis of the graphic. Which is the space +between the edge of the chart area and the data points. A larger margin +provides breathing room for the data points, preventing them from +getting too close to the axis lines or the edge of the chart. The +default value is NULL and it expects a value of type numeric (hdtype +Num).

+
+
+

axis_margin_y +

+

Controls the margin around the Y-axis in the graphic, which is the +space between the edge of the chart area and the data points along the +Y-axis. The default value is NA and it expects a value of type numeric +(hdtype Num).

+
+
+

axis_show +

+

Controls the visibility of the axes in a graphic. By default, it is +set to FALSE, meaning the axes are not shown. It expects a logical value +(hdtype Chk).

+
+
+

axis_tick_length +

+

Specifies the length of the tick marks along the axes of a chart. +These small lines help indicate specific values on the axes. The default +length is 10 and it expects a value of type numeric (hdtype Num).

+
+
+

axis_ticks_color +

+

Determines the color of the tick marks along the axes of a chart. If +set, this color is applied to the small lines that indicate specific +values on the axes. The default value is NA and this argument expects a +value of type character (hdtype Clr).

+
+
+

background_color +

+

Specifies the background color for the entire visualization. The +default color is #fafafa, which provides a neutral and clean background. +It expects a value of type character (hdtype Clr).

+
+
+

bar_padding +

+

Specifies the spacing between bars in a bar chart. The default value +is 0. This parameter can change the overall appearance of the chart, +making it more compact or more spaced out. It expects a numeric value +(hdtype Num).

+
+
+

bar_width +

+

Specifies the width of the bars in a bar chart. Adjusting this +parameter can visually impact the chart’s appearance, making it more +compact or more spaced out. The default value is 0 and it expects a +numeric value (hdtype Num).

+
+
+

border_color +

+

Specifies the color of the border around the visualization. The +default value is NULL, indicating no border color is set. It expects a +value of type character (hdtype Clr).

+
+
+

branding_background_color +

+

Specifies the background color for the area of the visualization +dedicated to the logo. The default value is NULL, but you can specify +the color using any valid format. It expects a value of type character +(hdtype Clr).

+
+
+

branding_include +

+

Controls the presence of the logo in the visualization. By default, +it is set to FALSE, indicating that the logo is not included.It expects +a logical value (hdtype Chk), either TRUE or FALSE.

+
+
+

branding_text +

+

Specifies the text used for the footer or logo space. By default, it +is set to “Created with Datasketch http://datasketch.co”. You can customize this text to +include your own branding or attribution information. It expects a value +of type character (hdtype Txt).

+
+
+

caption +

+

Provide a descriptive or explanatory text that accompanies a +visualization, providing additional context such as the data source. It +expects a value of type character (hdtype Txt).

+
+
+

caption_align +

+

Controls the alignment of the credits in the visualization. The +default alignment is “left” and it expects a value of type character +(hdtype Cat).

+
+
+

caption_color +

+

Controls the color of the text for the credits in the visualization. +The default color is #28333f and it expects a value of type character +(hdtype Clr).

+
+
+ +

Specify a link associated with the credits of the graph. It accepts +values of type character (hdtype Txt), where a valid URL can be provided +as a string. The default value is NULL.

+
+
+

caption_margin +

+

Specifies the margin around the credits of the visualization. The +default value is 15 and its it expects a value of type numeric (hdtype +Num).

+
+
+

caption_size +

+

Specifies the font size, in points, of the text in the credits of the +visualization. The default value is 12 and it expects a value of type +numeric (hdtype Num).

+
+
+

caption_weight +

+

Specifies the font weight used for the credits in a visualization. A +higher weight corresponds to a bolder text. The default value is NULL +and it expects a value of type character (hdtype Cat).

+
+
+

color_bins +

+

This option divides the data into categories based on color ranges. +This feature is particularly useful for creating heatmaps or graphs that +depend on the intensity of values. By default, it is set to NULL and it +expects a logical value (hdtype Chk).

+
+
+

color_bins_method +

+

Determines how data is grouped into bins (intervals) based on their +values and assigned colors in graphs like heatmaps or histograms. Common +methods include “quantile,” “equal,” “k-means,” and others, influencing +the distribution of data into color categories. The default value is +NULL, expecting a character value (hdtype Cat).

+
+
+

color_palette_categorical +

+

Specifies the color palette used for categorical data where each +category is represented by a different color. This argument takes a list +of colors (hdtype Lst[Clr]) in any valid format. By default, it has the +value +list(#385573, #ffa92a, #f06142, #99e8b3, #32a8ce, #996295, #e59fd7).

+
+
+

color_palette_divergening +

+

Specifies the color palette used to represent diverging data, where +colors represent two opposite extremes or value ranges, such as +hot/cold, high/low, etc. The argument expects a list of colors (hdtype +Lst[Clr]) in any valid format. By default, it is set to +list(#ff844e,#ffa154, #ffc48b, #eef0f1, #a0c7da, #57a0c5, #255b89).

+
+
+

color_palette_sequential +

+

Specifies the color palette used for sequential data, where every +color represent a sequence or gradient. Typically used to show intensity +or magnitude. It received a list of colors (hdtype Lst[Clr]) in any +valid format, its default value is +list(#b8f3ca, #add79c, #8dbd93, #70a38e, #568989, #3f6f83, #28557d).

+
+
+

datalabel_color +

+

Specifies the color of the text for data labels. By default, it is +NULL and it expects a value of type character (hdtype Clr).

+
+
+

datalabel_format_sample +

+

Specifies the format of the data labels. By default, it is NULL and +it expects a value of type character (hdtype Txt).

+
+
+

datalabel_formmater_js +

+

Specifies a JavaScript function to customize the format of the data +labels. By default, it is set to FALSE, indicating that no custom +formatting function is applied. This argument expects a logical value +(hdtype Chk).

+
+
+

datalabel_horizontal_align +

+

Determines the horizontal alignment of the data labels in a graph. By +default, it is set to center, meaning the labels are centered +horizontally. This argument expects a character value (hdtype Cat), with +possible values of center, right, and left.

+
+
+

datalabel_offset +

+

Specifies the offset of the data labels. It is used to adjust the +position of labels that display information about specific data points, +such as values or names. The default value is 0, which means no offset. +It expects a numeric value (hdtype Num).

+
+
+

datalabel_offset_x +

+

Specifies the horizontal offset of data labels. This adjustment helps +prevent label overlap and enhances readability. The default value is +1.1, which provides a slight rightward shift to the labels. It expects a +numeric value (hdtype Num).

+
+
+

datalabel_offset_y +

+

Adjusts the vertical position (Y-axis) of data labels in a graph, +helping to prevent text overlap. By default, this value is NULL, +allowing labels to be automatically positioned. It expects a numeric +value (hdtype Num).

+
+
+

datalabel_size +

+

Specifies the font size of data labels in a graph. The default value +is NULL and it expects a numeric value (hdtype Num).

+
+
+

datalabel_text_outline_show +

+

Turns the outline around the text of data labels on the chart on or +off. Enabling outline can improve readability against complex or +similarly colored backgrounds. By default, this feature is enabled +(TRUE) and expects a logical value (hdtype Chk).

+
+
+

datalabel_vertical_align +

+

Specifies the vertical alignment of data labels in a chart. The +default alignment is center, meaning labels are centered vertically. +Other possible values include top and bottom, allowing labels to align +at the top or bottom of the associated data points. It expects a +character value (hdtype Cat).

+
+
+

format_sample_cat +

+

Allows specifying how categorical data should be formatted, such as +whether to convert them to uppercase, lowercase, etc. It expects a +character value (hdtype Txt) and its default value is NULL, which means +no default formatting is applied.

+
+
+

format_sample_dat +

+

Used to format date-type data and allows to specify how date-type +data should be formatted (for example YYYY-MM-DD or DD/MM/YYYY). It +expects a character value (hdtype Txt) and the default value is NULL, +indicating that no specific formatting is applied by default.

+
+
+

format_sample_num +

+

Used to set the format for numbers in the visualization. If no format +is specified for axes, all numbers will use the format specified by this +argument. The default value is 1500 and this expects a value of type +character (hdtype Txt).

+
+
+

grid_color +

+

Specifies the overall color of the grid lines in a graph. This +parameter can affect both the X and Y axis grid lines if individual +colors are not specified (grid_x_color, grid_y_color). The default color +is #d1d9db, which is a light gray. It expects a value of type character +(hdtype Clr).

+
+
+

grid_line_type +

+

Specifies the line style for the grid in a graph, such as solid, +dotted, or dashed lines. The default style is “Dot” for dotted lines It +expects a character value (hdtype Cat), with options like “dot”, “line”, +and “dash”.

+
+
+

grid_size +

+

Specifies the general size of the grid lines in a graph. The default +size is 0.3. it expects a value of type numeric (hdtype Num).

+
+
+

grid_x_color +

+

Determines the color of the grid lines corresponding to the X-axis in +a chart. This color is crucial for distinguishing the divisions or marks +along the X-axis. The default color is #d1d9db. it expects a value of +type character (hdtype Clr).

+
+
+

grid_x_line_type +

+

Specifies the line type (solid, dashed, etc.) for the grid on the +X-axis. By default, this parameter is set to NULL. it expects a value of +type character (hdtype Cat).

+
+
+

grid_x_show +

+

Determines whether the grid lines along the X-axis are displayed. +When set to TRUE, the grid lines are shown. The default value is TRUE +and it expects a value of type logical (hdtype Chk).

+
+
+

grid_x_size +

+

Specifies the size of the grid lines associated with the X-axis in a +chart. A larger size makes the grid lines more noticeable. The default +value is 0, indicating that the grid lines are not visible. it expects a +value of type numeric (hdtype Num).

+
+
+

grid_x_width +

+

Specifies the width of the grid lines corresponding to the X-axis in +a chart. The default value is 1, indicating a standard width for the +grid lines. It expects a value of type numeric (hdtype Num).

+
+
+

grid_y_color +

+

Defines the color of the grid lines along the Y-axis in a chart. It +serves to differentiate the divisions or marks on the Y-axis. The +default color is #d1d9db. This argument expects a value of type +character (hdtype Clr)

+
+
+

grid_y_line_type +

+

Determines the style of the grid lines along the Y-axis. It allows +you to specify whether the lines should be solid, dotted, dashed, or +another style. The default value is NULL, meaning the line style is not +explicitly set. This argument expects a value of type character (hdtype +Cat).

+
+
+

grid_y_show +

+

Controls the visibility of the horizontal grid lines. When set to +TRUE, the grid lines along the Y-axis are displayed. If set to FALSE, +the horizontal grid lines will not be displayed. The default value is +TRUE, meaning the grid lines are shown. This argument expects a value of +type logical (hdtype Chk).

+
+
+

grid_y_size +

+

Specifies the size of the horizontal grid lines (related to the +Y-axis) in a graphic. The default value is NULL and this argument +expects a value of type numeric (hdtype Num).

+
+
+

grid_y_width +

+

Specifies the width of the grid lines corresponding to the Y-axis in +a chart. The default value is 1, which represents a standard width. This +argument expects a value of type numeric (hdtype Num).

+
+
+

highlight_values_color +

+

Specifies the color used to highlight specific values or elements in +the visualization. The default color is #50c5b7, which is a shade of +teal. It expects a value of type character (hdtype Clr).

+
+
+

legend_background +

+

Specifies the background color of the legend in the chart. The +default color is transparent and it expects a value of type character +(hdtype Clr).

+
+
+

legend_border_width +

+

Specifies the width of the border around the legend. The default +value is 0, which means no border is displayed. Increasing the value +will increase the widht of the border. It expects a numeric value +(hdtype Num).

+
+
+

legend_margin +

+

Specifies the width of the border around the legend in a +visualization. This affects the spacing between the legend and other +elements of the graph or the edges of the visualization. The default +value is 0 and it expects a value of type numeric (hdtype Num).

+
+
+

legend_margin_bottom +

+

Specifies the margin at the bottom of the legend in a visualization. +The default value is NULL, meaning no specific bottom margin is applied. +It expects a value of type numeric (hdtype Num).

+
+
+

legend_margin_left +

+

Specifies the margin to the left of the legend in a visualization. +The default value is NULL, meaning no specific left margin is applied. +It expects a value of type numeric (hdtype Num).

+
+
+

legend_margin_right +

+

Specifies the margin to the right of the legend in a visualization. +The default value is NULL, meaning no specific right margin is applied. +It expects a value of type numeric (hdtype Num).

+
+
+

legend_margin_top +

+

Adjusts the top margin of the legend in the chart. The default value +is NULL, meaning no specific top margin is applied. It expects a value +of type numeric (hdtype Num).

+
+
+

legend_show +

+

Ccontrols the visibility of the legend in a chart. The default value +is TRUE, meaning the legend is visible. It expects a value of type +logical (hdtype Chk).

+
+
+

legend_text_color +

+

Specifies the color of the text in the legend. By default, the color +is not explicitly set (NULL). It expects a value of type color (hdtype +Clr).

+
+
+

legend_text_family +

+

Specifies the font family for the text in the legend. The default +font family is IBM Plex Sans, providing a clean and modern look for the +legend text. It expects a value of type character (hdtype Fnt).

+
+
+

legend_text_horizontal_align +

+

Controls the horizontal alignment of the text within the legend box. +The default is center, which centers the text horizontally. Other +possible values include left and right. It expects a value of type +character (hdtype Cat).

+
+
+

legend_text_margin +

+

Sets the margin around the text inside the legend. The default value +isNULL, indicating no specific margin is set. It expects a numeric value +(hdtype Num).

+
+
+

legend_text_margin_bottom +

+

Defines the margin or space below the text of each item in the +legend, useful for controlling the spacing and arrangement of elements +within the legend. The default value is 0. It expects a value of type +numeric (hdtype Num).

+
+
+

legend_text_margin_left +

+

Defines the margin to the left of the text within the legend, +controlling the spacing and alignment of the text inside the legend. Its +default value is NULL, and it expects a numeric value (hdtype Num).

+
+
+

legend_text_margin_right +

+

Sets the margin to the right of the text within the legend, +controlling the spacing and alignment of the text inside the legend. Its +default value is NULL, and it expects a numeric value (hdtype Num).

+
+
+

legend_text_margin_top +

+

Sets the margin or space at the top of the text within the legend, +controlling the spacing and alignment of the text inside the legend. Its +default value is 0, and it expects a numeric value (hdtype Num).

+
+
+

legend_text_size +

+

Determines the size of the text inside the legend. Its default value +is 11, and it expects a numeric value representing the size in points +(hdtype Num).

+
+
+

legend_text_vertical_align +

+

Specifies the vertical alignment of the text within the legend. The +default value is center, which vertically centers the text. Other +possible values include top and bottom. It expects a value of type +character (hdtype Cat).

+
+
+

line_color +

+

Allows for the customization of line colors in a graph. The default +color is #BEC7D0, a light gray shade. This parameter expects a value of +type character (hdtype Clr).

+
+
+

line_marker +

+

Controls the visibility of markers in a line chart. When set to TRUE, +markers such as points, circles, or squares (as specified by +line_marker_type) are displayed along the lines. The default value is +FALSE, meaning that markers are not shown. This parameter expects a +logical value (hdtype Chk).

+
+
+

line_marker_size +

+

Defines the size of markers in a line graph. Markers are small +symbols (such as circles, squares, triangles) placed at data points +along the line. The default size is 4. This parameter expects a numeric +value (hdtype Num).

+
+
+

line_size +

+

Defines the thickness of the lines in a line chart.The default size +is 0.5 and this parameter expects a numeric value (hdtype Num).

+
+
+

locale +

+

Defines the regional settings that affect how data is presented, such +as date, currency, and number format. The default value is en-US, which +corresponds to English (United States). You can specify other locales to +format your data according to different regional conventions. This +parameter expects a character value (hdtype Cat).

+
+
+ +

Specifies the PNG, SVG, or link of the logo to be added to the +graph’s canvas. The default value is NULL, indicating that no logo is +added. This parameter expects a character type (hdtype Img).

+
+
+

logo_height +

+

Specifies the height of the logo in the graph’s canvas. The default +value is NULL, but you can provide a numeric value to set the height of +the logo in pixels. This parameter expects a numeric value (hdtype +Num).

+
+
+

logo_position +

+

Defines the position of the logo within the chart’s canvas. The +default position is “right,” indicating that the logo is placed on the +right side of the chart. You can specify a different position by +providing one of the following values:

+
    +
  • topleft

  • +
  • topcenter

  • +
  • topright

  • +
  • centerleft

  • +
  • centercenter

  • +
  • centerright

  • +
  • bottomleft

  • +
  • bottomcenter

  • +
  • bottomright

  • +
+

This parameter expects a character value (hdtype Cat).

+
+
+

logo_width +

+

Defines the width of the logo in the graph. The default value is +NULL, which means that the width is not specify and the logo will be +displayed at its original size. You can specify a numeric value (hdtype +Num) to adjust the width of the logo.

+
+
+

map_graticule +

+

Controls the display of a grid of lines (meridians and parallels) on +a map for geographic reference. When set to TRUE, the grid is displayed; +when set to FALSE, it is hidden. The default value is FALSE and this +parameter expects a logical value (hdtype Chk).

+
+
+

map_graticule_interval +

+

Sets the interval between lines of the graticule on a map. These +lines typically represent meridians and parallels to aid in geographic +orientation. The default value is 5, meaning that lines are drawn every +5 degrees. This parameter expects a numeric value (hdtype Num) +representing the interval in degrees.

+
+
+

map_provider_tile +

+

Specifies the tile provider used for map backgrounds. The default +value is “leaflet” and expects a value of type character (hdtype Cat) +representing the tile provider’s name.

+
+
+

plot_background_color +

+

Defines the background color of the plot area in a graph. The default +value is NA, meaning no specific color is set. This parameter expects a +value of type character (hdtype Clr) representing a color.

+
+
+

plot_border_color +

+

Defines the color of the border around the main plot area in a chart. +The default color is #d1d9d, light gray color. This parameter expects a +value of type character (hdtype Clr).

+
+
+

plot_border_width +

+

Determines the width of the border around the main plot area in a +chart. The default width is 1 and expects a value of type numeric +(hdtype Num).

+
+
+

plot_margin_bottom +

+

Controls the margin at the bottom of the plot area. It affects the +space between the plot area and other elements of the chart or the edges +of the visualization. The default value is NULL and expects a value of +type numeric (hdtype Num).

+
+
+

plot_margin_left +

+

Controls the margin on the left side of the plot area. It affects the +space between the plot area and other elements of the chart or the edges +of the visualization. The default value is NULL and expects a value of +type numeric (hdtype Num).

+
+
+

plot_margin_right +

+

Controls the margin on the right side of the plot area. Adjusting +this margin can be useful to ensure that all elements of the chart are +visible and not cramped. The default value is NA, expects a value of +type numeric (hdtype Num).

+
+
+

plot_margin_top +

+

Controls the margin at the top of the plot area. The default value is +10, providing a margin of 10 units. This parameter expects a value of +type numeric (hdtype Num).

+
+
+

subtitle_align +

+

Determines the alignment of the subtitle in the visualization. The +default alignment is left and its type is character (hdtype Cat), +meaning it accepts values such as “left”, “center”, or “right”.

+
+
+

subtitle_color +

+

Defines the color of the subtitle text in the visualization. You can +specify the color using any valid format. The default color is #28333f +and its type is character (hdtype Clr).

+
+
+

subtitle_size +

+

Specifies the font size, in points, of the subtitle text in the +visualization. The default size is 17 points and it expects a value of +type numeric (hdtype Num).

+
+
+

subtitle_weight +

+

Specifies the font weight of the subtitle text in the +visualization.The default weight is 700, and its type is character +(hdtype Cat).

+
+
+

table_table_background+ +

+

Defines the background color for the entire table. The default color +is #ffffff, which corresponds to white. You can change this value to +customize the background color of the table. This parameter expects a +color value (hdtype Clr).

+
+
+

text_color +

+

Specifies the general text color in the visualization. The default +color is #28333f, which is a dark blue-gray. You can change this value +to customize the text color throughout the visualization. This parameter +expects a color value (hdtype Clr).

+
+
+

text_size +

+

Specifies the general text size in the visualization. The default +size is 12, but you can adjust this value to make the text larger or +smaller throughout the visualization. This parameter expects a numeric +value (hdtype Num).

+
+
+

text_wrap +

+

Determines the maximum number of characters that can appear in a +single line of text in the visualization. If a text string exceeds this +limit, it will wrap onto the next line. The default value is 12, meaning +that text will wrap after 12 characters. This parameter expects a +numeric value (hdtype Num).

+
+
+

title_align +

+

Controls the alignment of the title within the visualization. By +default, the title is aligned to the left, but you can adjust it to be +centered or aligned to the right. it expects a value of type numeric +(hdtype Cat).

+
+
+

title_axis_color +

+

Specifies the color of the text used for the axis titles in a chart. +This helps distinguish the axis titles from other text in the +visualization. The default value is NULL, indicating that the color is +not explicitly set. It expects a value of type character (hdtype +Clr).

+
+
+

title_axis_size +

+

Defines the font size for the axis titles in a graphic. The default +size is 13 points, and you can specify values from 1 to 20 points. Its +type is numeric (hdtype Num).

+
+
+

title_color +

+

Specifies the color of the text used for the main title in a +visualization. The default color is #28333f and it expects a value of +type character(hdtype Clr).

+
+
+

title_family +

+

Specifies the font family used for the main title in a visualization. +The default font family is IBM Plex Sans and it expects a value of type +character(hdtype Fnt).

+
+
+

title_size +

+

Determines the font size of the visualization’s title. The default +size is 21 points but you can adjust this value from 1 to 20 points. It +expects a value of type numeric (hdtype Num).

+
+
+

title_weight +

+

Specifies the font weight of the visualization’s title. The default +weight is 700 (bold style), but you can choose between several options +such as thin, light, regular, medium, bold, and black. It expects a +value of type character (hdtype Cat).

+
+
+

tooltip_background +

+

Defines the background color of tooltips that provide additional +information when hovering over elements in the visualization. The +default color is #ffffff (white), but you can customize this color to +fit the style of the visualization. This parameter expects a color value +(hdtype Clr).

+
+
+

tooltip_text_family +

+

Defines the font family used for the text inside tooltips. The +default is NULL, which means the default font will be used. You can +specify a font family from the available fonts list to customize the +appearance of the tooltips. This parameter expects a character value +(hdtype Fnt).

+
+
+

tooltip_text_size +

+

Sets the font size for the text inside tooltips. The default size is +14 points, but you can specify a size between 1 and 20 points to adjust +the text size in the tooltips. This parameter expects a numeric value +representing the font size (hdtype Num).

+
+
+

x_max +

+

Sets the maximum value for the X-axis in a chart. It determines the +upper limit of the X-axis, controlling the range of data displayed along +this axis. The default value is NULL and expects a numeric value (hdtype +Num).

+
+
+

x_min +

+

Sets the minimum value for the X-axis in a chart. It determines the +lower limit of the X-axis, controlling the range of data displayed along +this axis. The default value is NULL and expects a numeric value (hdtype +Num).

+
+
+

y_axis_align +

+

Specifies the alignment of the Y-axis labels in a chart. It can be +set to “left”, “right”, or “center” relative to the axis. The default +value is NULL, which means that the alignment is determined +automatically and expects a character values (hdtype Cat).

+
+
+

y_max +

+

Set the maximum value represented on the Y-axis of a chart. This +parameter allows you to focus the visualization on a specific range of +interest by defining the upper limit of the Y-axis. The default value is +NULL and it expects a numerical value (hdtype Num).

+
+
+

y_min +

+

Sets the minimum value for the Y-axis in a chart. It determines the +lower limit of the Y-axis, controlling the range of data displayed along +this axis. The default value is NULL and it expects a numeric value +(hdtype Num).

+
+
+
+ + + +
+ + + +
+
+ + + + + + + diff --git a/docs/articles/titles_options.html b/docs/articles/titles_options.html new file mode 100644 index 0000000..a25e75f --- /dev/null +++ b/docs/articles/titles_options.html @@ -0,0 +1,293 @@ + + + + + + + + +titles options • dsopts + + + + + + + + + + Skip to contents + + +
+ + + + +
+
+ + + + +

This page aims to explain the options available in the titles +category. It will discuss the purpose of each argument, the possible +values it can take, and the expected outcome of each argument.

+
+

caption +

+

Provide a descriptive or explanatory text that accompanies a +visualization, providing additional context such as the data source. It +expects a value of type character (hdtype Txt).

+
+
+

caption_align +

+

Controls the alignment of the credits in the visualization. The +default alignment is “left” and it expects a value of type character +(hdtype Cat).

+
+
+

caption_color +

+

Controls the color of the text for the credits in the visualization. +The default color is #28333f and it expects a value of type character +(hdtype Clr).

+
+
+ +

Specify a link associated with the credits of the graph. It accepts +values of type character (hdtype Txt), where a valid URL can be provided +as a string. The default value is NULL.

+
+
+

caption_margin +

+

Specifies the margin around the credits of the visualization. The +default value is 15 and its it expects a value of type numeric (hdtype +Num).

+
+
+

caption_size +

+

Specifies the font size, in points, of the text in the credits of the +visualization. The default value is 12 and it expects a value of type +numeric (hdtype Num).

+
+
+

caption_weight +

+

Specifies the font weight used for the credits in a visualization. A +higher weight corresponds to a bolder text. The default value is NULL +and it expects a value of type character (hdtype Cat).

+
+
+

subtitle +

+

Defines secondary text that offers additional information or context +about the visualization, typically positioned below the main title and +it expects a value of type character (hdtype Txt).

+
+
+

subtitle_align +

+

Determines the alignment of the subtitle in the visualization. The +default alignment is left and its type is character (hdtype Cat), +meaning it accepts values such as “left”, “center”, or “right”.

+
+
+

subtitle_color +

+

Defines the color of the subtitle text in the visualization. You can +specify the color using any valid format. The default color is #28333f +and its type is character (hdtype Clr).

+
+
+

subtitle_size +

+

Specifies the font size, in points, of the subtitle text in the +visualization. The default size is 17 points and it expects a value of +type numeric (hdtype Num).

+
+
+

subtitle_weight +

+

Specifies the font weight of the subtitle text in the +visualization.The default weight is 700, and its type is character +(hdtype Cat).

+
+
+

title +

+

Defines the main title of the visualization, it accepts characters +values(hdtype Txt).

+
+
+

title_align +

+

Controls the alignment of the title within the visualization. By +default, the title is aligned to the left, but you can adjust it to be +centered or aligned to the right. it expects a value of type numeric +(hdtype Cat).

+
+
+

title_axis_color +

+

Specifies the color of the text used for the axis titles in a chart. +This helps distinguish the axis titles from other text in the +visualization. The default value is NULL, indicating that the color is +not explicitly set. It expects a value of type character (hdtype +Clr).

+
+
+

title_axis_size +

+

Defines the font size for the axis titles in a graphic. The default +size is 13 points, and you can specify values from 1 to 20 points. Its +type is numeric (hdtype Num).

+
+
+

title_color +

+

Specifies the color of the text used for the main title in a +visualization. The default color is #28333f and it expects a value of +type character(hdtype Clr).

+
+
+

title_family +

+

Specifies the font family used for the main title in a visualization. +The default font family is IBM Plex Sans and it expects a value of type +character(hdtype Fnt).

+
+
+

title_legend +

+

Defines the title for the legend in the visualization. The legend +helps viewers to identify the meaning of each color, shape, or symbol +used in the chart. Its type is character (hdtype Txt).

+
+
+

title_size +

+

Determines the font size of the visualization’s title. The default +size is 21 points but you can adjust this value from 1 to 20 points. It +expects a value of type numeric (hdtype Num).

+
+
+

title_weight +

+

Specifies the font weight of the visualization’s title. The default +weight is 700 (bold style), but you can choose between several options +such as thin, light, regular, medium, bold, and black. It expects a +value of type character (hdtype Cat).

+
+
+
+ + + +
+ + + +
+
+ + + + + + + diff --git a/docs/authors.html b/docs/authors.html index 1b81105..f03c79b 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -22,7 +22,7 @@ Reference diff --git a/docs/index.html b/docs/index.html index ef0dbcf..85a1155 100644 --- a/docs/index.html +++ b/docs/index.html @@ -39,7 +39,7 @@ Reference diff --git a/docs/reference/dsopts-package.html b/docs/reference/dsopts-package.html index c13d3f3..2469b1b 100644 --- a/docs/reference/dsopts-package.html +++ b/docs/reference/dsopts-package.html @@ -22,7 +22,7 @@ Reference diff --git a/docs/reference/dsopts_available.html b/docs/reference/dsopts_available.html index 7e3c94e..51be499 100644 --- a/docs/reference/dsopts_available.html +++ b/docs/reference/dsopts_available.html @@ -24,7 +24,7 @@ Reference diff --git a/docs/reference/dsopts_default.html b/docs/reference/dsopts_default.html index 8e0af79..d1635b3 100644 --- a/docs/reference/dsopts_default.html +++ b/docs/reference/dsopts_default.html @@ -24,7 +24,7 @@ Reference diff --git a/docs/reference/dsopts_merge.html b/docs/reference/dsopts_merge.html index e67637f..3b1ae4d 100644 --- a/docs/reference/dsopts_merge.html +++ b/docs/reference/dsopts_merge.html @@ -26,7 +26,7 @@ Reference diff --git a/docs/reference/index.html b/docs/reference/index.html index 3a5bdd8..823a58a 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -22,7 +22,7 @@ Reference diff --git a/docs/search.json b/docs/search.json index 39632b5..ae67e86 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -[{"path":"/articles/argui.html","id":"agg","dir":"Articles","previous_headings":"","what":"agg","title":"dataprep options","text":"Determines data summarized combined (e.g., sums, averages, maximums, minimums). expects character value specifying aggregation function (mean, max, min, etc.). default value “sum,” hd_type Categorical (Cat), allowing values like “sum Cat,” “mean Cat,” “max Cat,” “min Cat,” “std Cat,” “growth Cat.”","code":""},{"path":"/articles/argui.html","id":"agg_na_rm","dir":"Articles","previous_headings":"","what":"agg_na_rm","title":"dataprep options","text":"Indicates whether missing values (NA) removed aggregating data. expects value type logical, represents boolean values (possible values True False). default, value TRUE, hd_type Check (Chk).","code":""},{"path":"/articles/argui.html","id":"agg_text","dir":"Articles","previous_headings":"","what":"agg_text","title":"dataprep options","text":"Used label column name indicating type aggregation performed data. located “text” category, default value NULL hd_type Txt (Text). Possible values include ‘sum VAR,’ ‘mean VAR,’ ‘max VAR,’ indicating aggregation type (summed, averaged, maximum value taken) data column.","code":""},{"path":"/articles/argui.html","id":"drop_na","dir":"Articles","previous_headings":"","what":"drop_na","title":"dataprep options","text":"Enhances clarity visual representations excluding missing data (NA) set TRUE. hdtype Chk (Check), expecting logical value (TRUE FALSE) default, value FALSE.","code":""},{"path":"/articles/argui.html","id":"drop_na_var2","dir":"Articles","previous_headings":"","what":"drop_na_var2","title":"dataprep options","text":"Removes missing data (NA) second variable visualization. default value FALSE, hdtype Chk (Check), possible values TRUE FALSE.","code":""},{"path":"/articles/argui.html","id":"format_number_prefix","dir":"Articles","previous_headings":"","what":"format_number_prefix","title":"dataprep options","text":"Formats numeric values using SI prefixes represent large numbers readable format k (thousands), M (millions) numeric values.expects logical value (TRUE FALSE), default value FALSE hdtype chk (Check).","code":""},{"path":"/articles/argui.html","id":"format_sample_cat","dir":"Articles","previous_headings":"","what":"format_sample_cat","title":"dataprep options","text":"Allows specifying categorical data formatted, whether convert uppercase, lowercase, etc. hdtype Txt (text) found theme, format, dataclean categories. default value NULL, means default formatting applied.","code":""},{"path":"/articles/argui.html","id":"format_sample_dat","dir":"Articles","previous_headings":"","what":"format_sample_dat","title":"dataprep options","text":"Used format date-type data allows specify date-type data formatted (example YYYY-MM-DD DD/MM/YYYY). also found theme format categories, hdtype Txt (text). default value NULL, indicating specific formatting applied default.","code":""},{"path":"/articles/argui.html","id":"format_sample_num","dir":"Articles","previous_headings":"","what":"format_sample_num","title":"dataprep options","text":"Used set format numbers visualization. format specified axes, numbers use format specified argument. default value 1500(Review) also found theme format categories. argument expects character type (Review).","code":""},{"path":"/articles/argui.html","id":"na_label","dir":"Articles","previous_headings":"","what":"na_label","title":"dataprep options","text":"Replaces NA values dataset specified label. example, setting na_label = “Available” display “Available” instead NA visual representation data. located text category, hdtype Txt (text), expects character type value.","code":""},{"path":"/articles/argui.html","id":"percentage","dir":"Articles","previous_headings":"","what":"percentage","title":"dataprep options","text":"Calculates percentage indicated numerical variable. Found bar pie categories. default value FALSE, hdtype chk (check) argument expects logical value (TRUE FALSE)","code":""},{"path":"/articles/argui.html","id":"percentage_col","dir":"Articles","previous_headings":"","what":"percentage_col","title":"dataprep options","text":"Specifies name names categorical variable(s) want calculate percentages.example, dataset columns “category” “value” representing different categories corresponding values, can use percentage_col = “category” calculate percentage category. default value NULL, hdtype Txt (text).","code":""},{"path":"/articles/argui.html","id":"percentage_intra","dir":"Articles","previous_headings":"","what":"percentage_intra","title":"dataprep options","text":"Calculates percentages within individual categories groups visualization. Defaulting FALSE, expect logical value hdtype Chk (Check).","code":""},{"path":"/articles/argui.html","id":"percentage_name","dir":"Articles","previous_headings":"","what":"percentage_name","title":"dataprep options","text":"Specifies character value used name column containing calculated percentages. used provide descriptive name percentage column output visualization dataset percentage TRUE. hdtype Txt (text) type input character (text).","code":""},{"path":"/articles/argui.html","id":"tooltip_agg_collapse_rows_template","dir":"Articles","previous_headings":"","what":"tooltip_agg_collapse_rows_template","title":"dataprep options","text":"Controls aggregation data tooltips, determining whether similar related rows collapsed single entry tooltip avoid repetition. takes dataframe template inputs returns column strings applied template. template can apply different aggregations mean max. Found tooltip category, hdtype Cat (categorical). possible values functions sum, mean, etc., used specify type aggregation tooltip.","code":""},{"path":"/articles/argui.html","id":"tooltip_include_all_vars","dir":"Articles","previous_headings":"","what":"tooltip_include_all_vars","title":"dataprep options","text":"Includes available variables entered dataframe visualization. also found tooltip category, default value FALSE. hdtype Chk (Check).","code":""},{"path":"/articles/argui.html","id":"tooltip_sep_all_vars","dir":"Articles","previous_headings":"","what":"tooltip_sep_all_vars","title":"dataprep options","text":"Specifies separator used tooltips multiple variables included, allowing clear separation organization information.. also found tooltip category, hdtype Cat (categorical).","code":""},{"path":"/articles/argui.html","id":"tooltip_template","dir":"Articles","previous_headings":"","what":"tooltip_template","title":"dataprep options","text":"Used customization template tooltips, also located tooltip category. template allows customize content format tooltips visualization, using specific variables dataframe display detailed relevant information hovering elements visualization.hdtype Txt (text), possible values text match names variables dataframe.","code":""},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Camila Achuri. Author, maintainer.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Achuri C (2024). dsopts: dsopts. R package version 0.0.0.9000.","code":"@Manual{, title = {dsopts: dsopts}, author = {Camila Achuri}, year = {2024}, note = {R package version 0.0.0.9000}, }"},{"path":"/index.html","id":"dsopts","dir":"","previous_headings":"","what":"dsopts ","title":"dsopts ","text":"goal dsopts provide set options used datasketch data visualization processing packages","code":""},{"path":"/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"dsopts ","text":"install development version dsopts GitHub :","code":"# install.packages(\"devtools\") devtools::install_github(\"datasketch/dsopts\")"},{"path":"/index.html","id":"examples","dir":"","previous_headings":"","what":"Examples","title":"dsopts ","text":"see available options use: dsopts_available() get defaults override defaults override defaults list options","code":"library(dsopts) ## basic example code # See all available options for a category dsopts_available(\"treemap\") #> [1] \"treemap_direction\" \"treemap_layers\" \"treemap_layers_params\" #> [4] \"treemap_layout\" # See all available options for a category dsopts_available(\"zoom\") #> [1] \"map_zoom_delta\" \"map_zoom_snap\" \"x_max\" \"y_max\" #> [5] \"zoom_level\" \"zoom_max\" \"zoom_min\" \"zoom_show\" # Can handle multiple categories # This returns the options with both categories dsopts_available(c(\"map\", \"bubble\")) #> [1] \"bubble_max\" \"bubble_min\" \"bubble_opacity\" # This returns the options with any of categories dsopts_available(c(\"map\", \"bubble\"), type = \"any_of\") #> [1] \"border_opacity\" \"bubble_max\" \"bubble_min\" #> [4] \"bubble_opacity\" \"map_bubble_cluster\" \"map_graticule\" #> [7] \"map_graticule_interval\" \"map_name\" \"map_name_layers_params\" #> [10] \"map_popup\" \"map_projection_params\" \"map_zoom_delta\" #> [13] \"map_zoom_snap\" \"zoom_level\" dsopts_default(categories = \"donut\") #> $donut_width #> [1] 2 #> #> $sort #> [1] \"no\" dsopts_merge(donut_width = 1, categories = \"donut\") #> $donut_width #> [1] 1 #> #> $sort #> [1] \"no\" opts <- list( donut_width = 2 ) dsopts_merge(donut_width = 1, opts = opts, categories = \"donut\") #> $donut_width #> [1] 2 #> #> $sort #> [1] \"no\""},{"path":"/reference/dsopts-package.html","id":null,"dir":"Reference","previous_headings":"","what":"dsopts: dsopts — dsopts-package","title":"dsopts: dsopts — dsopts-package","text":"package (one paragraph).","code":""},{"path":"/reference/dsopts-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"dsopts: dsopts — dsopts-package","text":"Maintainer: Camila Achuri first.last@example.com (ORCID)","code":""},{"path":"/reference/dsopts_available.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Available Options — dsopts_available","title":"Retrieve Available Options — dsopts_available","text":"function retrieves available options dsopts package, optionally filtered specified categories.","code":""},{"path":"/reference/dsopts_available.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Available Options — dsopts_available","text":"","code":"dsopts_available(categories = NULL, type = \"all_of\")"},{"path":"/reference/dsopts_available.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Available Options — dsopts_available","text":"categories vector character strings specifying categories options retrieve. NULL (default), categories considered. type character string specifying type filter apply categories specified. Default \"all_of\".","code":""},{"path":"/reference/dsopts_available.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Available Options — dsopts_available","text":"sorted vector names available options. categories specified, options categories returned.","code":""},{"path":"/reference/dsopts_available.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Available Options — dsopts_available","text":"","code":"if (FALSE) { # Assuming 'my_category' as a valid option category available_opts <- dsopts_available(categories = 'my_category') }"},{"path":"/reference/dsopts_default.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Default Options for a Specific Category — dsopts_default","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"function retrieves default options dsopts package specific category. category specified, returns default options categories.","code":""},{"path":"/reference/dsopts_default.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"","code":"dsopts_default(categories = NULL, type = \"all_of\")"},{"path":"/reference/dsopts_default.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"categories character string specifying category options retrieve. NULL (default), categories considered. type all_of any_of multiples categories provided","code":""},{"path":"/reference/dsopts_default.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"named list default options. category specified, options category returned.","code":""},{"path":"/reference/dsopts_default.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"","code":"if (FALSE) { # Assuming 'category' as a valid option category default_opts <- dsopts_default(category = 'my_category') }"},{"path":"/reference/dsopts_merge.html","id":null,"dir":"Reference","previous_headings":"","what":"Merge Default and User-Defined Options — dsopts_merge","title":"Merge Default and User-Defined Options — dsopts_merge","text":"function merges user-defined options default options dsopts package. category specified, options category considered. User-defined options overwrite default ones.","code":""},{"path":"/reference/dsopts_merge.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Merge Default and User-Defined Options — dsopts_merge","text":"","code":"dsopts_merge(..., categories = NULL)"},{"path":"/reference/dsopts_merge.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Merge Default and User-Defined Options — dsopts_merge","text":"... User-defined options merge defaults. category character string specifying category options merge. NULL (default), categories considered.","code":""},{"path":"/reference/dsopts_merge.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Merge Default and User-Defined Options — dsopts_merge","text":"named list merged options. category specified, options category returned.","code":""},{"path":"/reference/dsopts_merge.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Merge Default and User-Defined Options — dsopts_merge","text":"","code":"if (FALSE) { # Assuming 'my_option' as a valid option name and 'my_category' as a valid option category merged_opts <- dsopts_merge(my_option = 'my_value', category = 'my_category') }"},{"path":"/reference/dsopt_default.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Default Option — dsopt_default","title":"Retrieve Default Option — dsopt_default","text":"function retrieves default value specified option dsopts package.","code":""},{"path":"/reference/dsopt_default.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Default Option — dsopt_default","text":"","code":"dsopt_default(opt)"},{"path":"/reference/dsopt_default.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Default Option — dsopt_default","text":"opt character string specifying name option whose default value retrieved.","code":""},{"path":"/reference/dsopt_default.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Default Option — dsopt_default","text":"default value specified option. option exist, returns NULL.","code":""},{"path":"/reference/dsopt_default.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Default Option — dsopt_default","text":"","code":"if (FALSE) { # Assuming 'my_option' as a valid option name default_opt <- dsopt_default(opt = 'my_option') }"}] +[{"path":"/articles/axis_options.html","id":"axis_flip","dir":"Articles","previous_headings":"","what":"axis_flip","title":"axis options","text":"Swaps X Y axes plot. default, set FALSE, meaning axes flipped. set TRUE, orientation plot changes. argument expects logical values (hdtype Chk).","code":""},{"path":"/articles/axis_options.html","id":"axis_line_x_size","dir":"Articles","previous_headings":"","what":"axis_line_x_size","title":"axis options","text":"Specifies size thickness X-axis line plot. default size 0 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/axis_options.html","id":"axis_reversed","dir":"Articles","previous_headings":"","what":"axis_reversed","title":"axis options","text":"Reverses axes plot, flipping Y-axis higher values appear bottom.default value FALSE, meaning axes reversed. value type logical (hdtype Chk), possible values TRUE FALSE.","code":""},{"path":"/articles/axis_options.html","id":"axis_text_angle","dir":"Articles","previous_headings":"","what":"axis_text_angle","title":"axis options","text":"Specifies angle axis text graphic. can help improve readability many labels labels long. default angle 0 degrees, means text horizontal.can specify angle -90 90 degrees rotate text. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/axis_options.html","id":"axis_text_wrap","dir":"Articles","previous_headings":"","what":"axis_text_wrap","title":"axis options","text":"Specifies number words wrap axis labels wrapping onto next line. default, set 6, axis labels wrap next line 6 words. allows long labels displayed multiple lines, improving readability. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/axis_options.html","id":"axis_x_reversed","dir":"Articles","previous_headings":"","what":"axis_x_reversed","title":"axis options","text":"Reverses order data X-axis chart. set True, highest values appear left lowest values right. expects value type logical (hdtype Chk).","code":""},{"path":"/articles/axis_options.html","id":"axis_x_text_angle","dir":"Articles","previous_headings":"","what":"axis_x_text_angle","title":"axis options","text":"Specifies angle labels X-axis chart.default value NULL, means rotation applied. Also, can specify angle -90 90 degrees rotate text. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/axis_options.html","id":"axis_x_text_wrap","dir":"Articles","previous_headings":"","what":"axis_x_text_wrap","title":"axis options","text":"Specifies number words labels X-axis chart. allows long labels displayed multiple lines avoids text overlap. default value NULL, indicating word wrapping applied. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/axis_options.html","id":"axis_y_reversed","dir":"Articles","previous_headings":"","what":"axis_y_reversed","title":"axis options","text":"Inverts axes chart (e.g., reverses Y-axis higher values closer origin). chart flipped, X-axis reversed default means order data Y-axis reversed. default value FALSE, indicating axes reversed. expects value type logical (hdtype Chk).","code":""},{"path":"/articles/axis_options.html","id":"axis_y_text_angle","dir":"Articles","previous_headings":"","what":"axis_y_text_angle","title":"axis options","text":"Controls angle labels Y-axis. default value NULL, means rotation applied. angle can range -90 90 degrees. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/axis_options.html","id":"axis_y_text_wrap","dir":"Articles","previous_headings":"","what":"axis_y_text_wrap","title":"axis options","text":"Specifies number words labels Y-axis chart. parameter allows long labels displayed multiple lines, preventing text overlap. default value NULL, indicating word wrapping applied. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/axis_options.html","id":"title_axis_color","dir":"Articles","previous_headings":"","what":"title_axis_color","title":"axis options","text":"Specifies color text used axis titles chart. helps distinguish axis titles text visualization. default value NULL, indicating color explicitly set. expects value type character (hdtype Clr).","code":""},{"path":"/articles/axis_options.html","id":"title_axis_size","dir":"Articles","previous_headings":"","what":"title_axis_size","title":"axis options","text":"Defines font size axis titles graphic. default size 13 points, can specify values 1 20 points. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/axis_options.html","id":"title_axis_x","dir":"Articles","previous_headings":"","what":"title_axis_x","title":"axis options","text":"Specifies title X-axis chart, describing variable data represented horizontal axis. expects value type character (hdtype Txt).","code":""},{"path":"/articles/axis_options.html","id":"title_axis_y","dir":"Articles","previous_headings":"","what":"title_axis_y","title":"axis options","text":"Specifies title Y-axis chart, describing variable data represented vertical axis. expects value type character (hdtype Txt).","code":""},{"path":"/articles/axis_options.html","id":"title_axis_y2","dir":"Articles","previous_headings":"","what":"title_axis_y2","title":"axis options","text":"Specifies title secondary Y-axis chart. charts two Y-axes, axis can represent different types data scales, title help identify nature data represented secondary Y-axis. default value NULL argument expects value type character (hdtype Txt).","code":""},{"path":"/articles/colorprep_options.html","id":"color_by","dir":"Articles","previous_headings":"","what":"color_by","title":"colorprep options","text":"Specifies variable used color elements visualization. determines elements colored based different categories groups. set NULL, default color scale often applied, expects character value (hdtype Txt) representing variable name.","code":""},{"path":"/articles/colorprep_options.html","id":"color_palette_categorical","dir":"Articles","previous_headings":"","what":"color_palette_categorical","title":"colorprep options","text":"Specifies color palette used categorical data category represented different color. argument takes list colors (hdtype Lst[Clr]) valid format. default, value list(#385573, #ffa92a, #f06142, #99e8b3, #32a8ce, #996295, #e59fd7).","code":""},{"path":"/articles/colorprep_options.html","id":"color_palette_divergening","dir":"Articles","previous_headings":"","what":"color_palette_divergening","title":"colorprep options","text":"Specifies color palette used represent diverging data, colors represent two opposite extremes value ranges, hot/cold, high/low, etc. argument expects list colors (hdtype Lst[Clr]) valid format. default, set list(#ff844e, #ffa154, #ffc48b, #eef0f1, #a0c7da, #57a0c5, #255b89).","code":""},{"path":"/articles/colorprep_options.html","id":"color_palette_sequential","dir":"Articles","previous_headings":"","what":"color_palette_sequential","title":"colorprep options","text":"Specifies color palette used sequential data, every color represent sequence gradient. Typically used show intensity magnitude. received list colors (hdtype Lst[Clr]) valid format, default value list(#b8f3ca, #add79c, #8dbd93, #70a38e, #568989, #3f6f83, #28557d).","code":""},{"path":"/articles/colorprep_options.html","id":"color_palette_type","dir":"Articles","previous_headings":"","what":"color_palette_type","title":"colorprep options","text":"Specifies type color palette used visualization. defaults NULL possible values include “categorical,” “sequential,” “diverging” (hdtype Cat).","code":""},{"path":"/articles/colorprep_options.html","id":"highlight_values_color","dir":"Articles","previous_headings":"","what":"highlight_values_color","title":"colorprep options","text":"Specifies color used highlight specific values elements visualization. default color #50c5b7, expects value type character (hdtype Clr), can specified valid color format.","code":""},{"path":"/articles/colorprep_options.html","id":"na_color","dir":"Articles","previous_headings":"","what":"na_color","title":"colorprep options","text":"Specifies color used represent missing “NA” (Available) data. default color #cbcdcf, expects value type character (hdtype Clr), can specified valid color format.","code":""},{"path":"/articles/dataprep_options.html","id":"agg","dir":"Articles","previous_headings":"","what":"agg","title":"dataprep options","text":"Determines data summarized combined (e.g., sums, averages, maximums, minimums). expects character value (hdtype Cat) specifying aggregation function (mean, max, min, etc.). default value “sum”.","code":""},{"path":"/articles/dataprep_options.html","id":"agg_na_rm","dir":"Articles","previous_headings":"","what":"agg_na_rm","title":"dataprep options","text":"Indicates whether missing values (NA) removed aggregating data. expects value type logical, represents boolean values (hdtype Chk) True False default, value TRUE.","code":""},{"path":"/articles/dataprep_options.html","id":"agg_text","dir":"Articles","previous_headings":"","what":"agg_text","title":"dataprep options","text":"Used label column name indicating type aggregation performed data. expects character value (hdtype Txt) default value NULL. Possible values include ‘sum VAR,’ ‘mean VAR,’ ‘max VAR,’ indicating aggregation type (summed, averaged, maximum value taken) data column.","code":""},{"path":"/articles/dataprep_options.html","id":"drop_na","dir":"Articles","previous_headings":"","what":"drop_na","title":"dataprep options","text":"Enhances clarity visual representations excluding missing data (NA) set TRUE. expects logical value (hdtype Chk) TRUE FALSE, default, value FALSE.","code":""},{"path":"/articles/dataprep_options.html","id":"drop_na_var2","dir":"Articles","previous_headings":"","what":"drop_na_var2","title":"dataprep options","text":"Removes missing data (NA) second variable visualization. default value FALSE possible values TRUE FALSE (hdtype Chk).","code":""},{"path":"/articles/dataprep_options.html","id":"format_number_prefix","dir":"Articles","previous_headings":"","what":"format_number_prefix","title":"dataprep options","text":"Formats numeric values using SI prefixes represent large numbers readable format k (thousands), M (millions) numeric values. expects logical value (hdtype Chk) TRUE FALSE, default value FALSE.","code":""},{"path":"/articles/dataprep_options.html","id":"format_sample_cat","dir":"Articles","previous_headings":"","what":"format_sample_cat","title":"dataprep options","text":"Allows specifying categorical data formatted, whether convert uppercase, lowercase, etc. expects character value (hdtype Txt) default value NULL, means default formatting applied.","code":""},{"path":"/articles/dataprep_options.html","id":"format_sample_dat","dir":"Articles","previous_headings":"","what":"format_sample_dat","title":"dataprep options","text":"Used format date-type data allows specify date-type data formatted (example YYYY-MM-DD DD/MM/YYYY). expects character value (hdtype Txt) default value NULL, indicating specific formatting applied default.","code":""},{"path":"/articles/dataprep_options.html","id":"format_sample_num","dir":"Articles","previous_headings":"","what":"format_sample_num","title":"dataprep options","text":"Used set format numbers visualization. format specified axes, numbers use format specified argument. default value 1500 argument expects character type (hdtype Txt).","code":""},{"path":"/articles/dataprep_options.html","id":"na_label","dir":"Articles","previous_headings":"","what":"na_label","title":"dataprep options","text":"Replaces NA values dataset specified label. example, setting na_label = “Available” display “Available” instead NA visual representation data. expects character type value (hdtype Txt).","code":""},{"path":"/articles/dataprep_options.html","id":"percentage","dir":"Articles","previous_headings":"","what":"percentage","title":"dataprep options","text":"Calculates percentage indicated numerical variable. default value FALSE argument expects logical value (hdtype Chk) TRUE FALSE.","code":""},{"path":"/articles/dataprep_options.html","id":"percentage_col","dir":"Articles","previous_headings":"","what":"percentage_col","title":"dataprep options","text":"Specifies name names categorical variable(s) want calculate percentages. example, dataset columns “category” “value” representing different categories corresponding values, can use percentage_col = “category” calculate percentage category. default value NULL, expects character value (hdtype Txt).","code":""},{"path":"/articles/dataprep_options.html","id":"percentage_intra","dir":"Articles","previous_headings":"","what":"percentage_intra","title":"dataprep options","text":"Calculates percentages within individual categories groups visualization. Defaulting FALSE, expect logical value TRUE FALSE (hdtype Chk).","code":""},{"path":"/articles/dataprep_options.html","id":"percentage_name","dir":"Articles","previous_headings":"","what":"percentage_name","title":"dataprep options","text":"Specifies character value used name column containing calculated percentages. provides descriptive name percentage column output visualization dataset. default, value NULL type value character (hdtype Txt).","code":""},{"path":"/articles/dataprep_options.html","id":"tooltip_agg_collapse_rows_template","dir":"Articles","previous_headings":"","what":"tooltip_agg_collapse_rows_template","title":"dataprep options","text":"Controls aggregation data tooltips, determining whether similar related rows collapsed single entry tooltip avoid repetition. takes dataframe template inputs returns column strings applied template. template can apply different aggregations mean max. template can apply different aggregations mean max. possible values functions sum, mean, etc (hdtype Cat) used specify type aggregation tooltip.","code":""},{"path":"/articles/dataprep_options.html","id":"tooltip_include_all_vars","dir":"Articles","previous_headings":"","what":"tooltip_include_all_vars","title":"dataprep options","text":"Includes available variables entered dataframe visualization. default value FALSE expects logical value TRUE FALSE (hdtype Chk).","code":""},{"path":"/articles/dataprep_options.html","id":"tooltip_sep_all_vars","dir":"Articles","previous_headings":"","what":"tooltip_sep_all_vars","title":"dataprep options","text":"Specifies separator used tooltips multiple variables included, allowing clear separation organization information. expects character value (hdtype Cat).","code":""},{"path":"/articles/dataprep_options.html","id":"tooltip_template","dir":"Articles","previous_headings":"","what":"tooltip_template","title":"dataprep options","text":"Used customization template tooltips, template allows customize content format tooltips visualization, using specific variables dataframe display detailed relevant information hovering elements visualization. possible values character (hdtype Txt) match names variables dataframe.","code":""},{"path":"/articles/theme_options.html","id":"animation_duration","dir":"Articles","previous_headings":"","what":"animation_duration","title":"theme options","text":"Specifies duration animations visualization, milliseconds. default value 0, indicating animation. expects value type numeric (hdtype Num) range [0, 3000] milliseconds.","code":""},{"path":"/articles/theme_options.html","id":"axis_line_color","dir":"Articles","previous_headings":"","what":"axis_line_color","title":"theme options","text":"Specifies color axis lines graphic. default color #7e858c. expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"axis_line_size","dir":"Articles","previous_headings":"","what":"axis_line_size","title":"theme options","text":"Controls thickness axis lines graphic. larger size makes axes prominent, helping emphasize within visualization. default value NA, means size explicitly set. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"axis_line_x_size","dir":"Articles","previous_headings":"","what":"axis_line_x_size","title":"theme options","text":"Specifies size thickness X-axis line plot. default size 0 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"axis_line_y_size","dir":"Articles","previous_headings":"","what":"axis_line_y_size","title":"theme options","text":"Specifies size thickness Y-axis line plot. default size 1 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"axis_margin_x","dir":"Articles","previous_headings":"","what":"axis_margin_x","title":"theme options","text":"Controls margin X-axis graphic. space edge chart area data points. larger margin provides breathing room data points, preventing getting close axis lines edge chart. default value NULL expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"axis_margin_y","dir":"Articles","previous_headings":"","what":"axis_margin_y","title":"theme options","text":"Controls margin around Y-axis graphic, space edge chart area data points along Y-axis. default value NA expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"axis_show","dir":"Articles","previous_headings":"","what":"axis_show","title":"theme options","text":"Controls visibility axes graphic. default, set FALSE, meaning axes shown. expects logical value (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"axis_tick_length","dir":"Articles","previous_headings":"","what":"axis_tick_length","title":"theme options","text":"Specifies length tick marks along axes chart. small lines help indicate specific values axes. default length 10 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"axis_ticks_color","dir":"Articles","previous_headings":"","what":"axis_ticks_color","title":"theme options","text":"Determines color tick marks along axes chart. set, color applied small lines indicate specific values axes. default value NA argument expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"background_color","dir":"Articles","previous_headings":"","what":"background_color","title":"theme options","text":"Specifies background color entire visualization. default color #fafafa, provides neutral clean background. expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"bar_padding","dir":"Articles","previous_headings":"","what":"bar_padding","title":"theme options","text":"Specifies spacing bars bar chart. default value 0. parameter can change overall appearance chart, making compact spaced . expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"bar_width","dir":"Articles","previous_headings":"","what":"bar_width","title":"theme options","text":"Specifies width bars bar chart. Adjusting parameter can visually impact chart’s appearance, making compact spaced . default value 0 expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"border_color","dir":"Articles","previous_headings":"","what":"border_color","title":"theme options","text":"Specifies color border around visualization. default value NULL, indicating border color set. expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"branding_background_color","dir":"Articles","previous_headings":"","what":"branding_background_color","title":"theme options","text":"Specifies background color area visualization dedicated logo. default value NULL, can specify color using valid format. expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"branding_include","dir":"Articles","previous_headings":"","what":"branding_include","title":"theme options","text":"Controls presence logo visualization. default, set FALSE, indicating logo included.expects logical value (hdtype Chk), either TRUE FALSE.","code":""},{"path":"/articles/theme_options.html","id":"branding_text","dir":"Articles","previous_headings":"","what":"branding_text","title":"theme options","text":"Specifies text used footer logo space. default, set “Created Datasketch http://datasketch.co”. can customize text include branding attribution information. expects value type character (hdtype Txt).","code":""},{"path":"/articles/theme_options.html","id":"caption","dir":"Articles","previous_headings":"","what":"caption","title":"theme options","text":"Provide descriptive explanatory text accompanies visualization, providing additional context data source. expects value type character (hdtype Txt).","code":""},{"path":"/articles/theme_options.html","id":"caption_align","dir":"Articles","previous_headings":"","what":"caption_align","title":"theme options","text":"Controls alignment credits visualization. default alignment “left” expects value type character (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"caption_color","dir":"Articles","previous_headings":"","what":"caption_color","title":"theme options","text":"Controls color text credits visualization. default color #28333f expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"caption_link","dir":"Articles","previous_headings":"","what":"caption_link","title":"theme options","text":"Specify link associated credits graph. accepts values type character (hdtype Txt), valid URL can provided string. default value NULL.","code":""},{"path":"/articles/theme_options.html","id":"caption_margin","dir":"Articles","previous_headings":"","what":"caption_margin","title":"theme options","text":"Specifies margin around credits visualization. default value 15 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"caption_size","dir":"Articles","previous_headings":"","what":"caption_size","title":"theme options","text":"Specifies font size, points, text credits visualization. default value 12 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"caption_weight","dir":"Articles","previous_headings":"","what":"caption_weight","title":"theme options","text":"Specifies font weight used credits visualization. higher weight corresponds bolder text. default value NULL expects value type character (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"color_bins","dir":"Articles","previous_headings":"","what":"color_bins","title":"theme options","text":"option divides data categories based color ranges. feature particularly useful creating heatmaps graphs depend intensity values. default, set NULL expects logical value (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"color_bins_method","dir":"Articles","previous_headings":"","what":"color_bins_method","title":"theme options","text":"Determines data grouped bins (intervals) based values assigned colors graphs like heatmaps histograms. Common methods include “quantile,” “equal,” “k-means,” others, influencing distribution data color categories. default value NULL, expecting character value (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"color_palette_categorical","dir":"Articles","previous_headings":"","what":"color_palette_categorical","title":"theme options","text":"Specifies color palette used categorical data category represented different color. argument takes list colors (hdtype Lst[Clr]) valid format. default, value list(#385573, #ffa92a, #f06142, #99e8b3, #32a8ce, #996295, #e59fd7).","code":""},{"path":"/articles/theme_options.html","id":"color_palette_divergening","dir":"Articles","previous_headings":"","what":"color_palette_divergening","title":"theme options","text":"Specifies color palette used represent diverging data, colors represent two opposite extremes value ranges, hot/cold, high/low, etc. argument expects list colors (hdtype Lst[Clr]) valid format. default, set list(#ff844e,#ffa154, #ffc48b, #eef0f1, #a0c7da, #57a0c5, #255b89).","code":""},{"path":"/articles/theme_options.html","id":"color_palette_sequential","dir":"Articles","previous_headings":"","what":"color_palette_sequential","title":"theme options","text":"Specifies color palette used sequential data, every color represent sequence gradient. Typically used show intensity magnitude. received list colors (hdtype Lst[Clr]) valid format, default value list(#b8f3ca, #add79c, #8dbd93, #70a38e, #568989, #3f6f83, #28557d).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_color","dir":"Articles","previous_headings":"","what":"datalabel_color","title":"theme options","text":"Specifies color text data labels. default, NULL expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_format_sample","dir":"Articles","previous_headings":"","what":"datalabel_format_sample","title":"theme options","text":"Specifies format data labels. default, NULL expects value type character (hdtype Txt).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_formmater_js","dir":"Articles","previous_headings":"","what":"datalabel_formmater_js","title":"theme options","text":"Specifies JavaScript function customize format data labels. default, set FALSE, indicating custom formatting function applied. argument expects logical value (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_horizontal_align","dir":"Articles","previous_headings":"","what":"datalabel_horizontal_align","title":"theme options","text":"Determines horizontal alignment data labels graph. default, set center, meaning labels centered horizontally. argument expects character value (hdtype Cat), possible values center, right, left.","code":""},{"path":"/articles/theme_options.html","id":"datalabel_offset","dir":"Articles","previous_headings":"","what":"datalabel_offset","title":"theme options","text":"Specifies offset data labels. used adjust position labels display information specific data points, values names. default value 0, means offset. expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_offset_x","dir":"Articles","previous_headings":"","what":"datalabel_offset_x","title":"theme options","text":"Specifies horizontal offset data labels. adjustment helps prevent label overlap enhances readability. default value 1.1, provides slight rightward shift labels. expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_offset_y","dir":"Articles","previous_headings":"","what":"datalabel_offset_y","title":"theme options","text":"Adjusts vertical position (Y-axis) data labels graph, helping prevent text overlap. default, value NULL, allowing labels automatically positioned. expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_size","dir":"Articles","previous_headings":"","what":"datalabel_size","title":"theme options","text":"Specifies font size data labels graph. default value NULL expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_text_outline_show","dir":"Articles","previous_headings":"","what":"datalabel_text_outline_show","title":"theme options","text":"Turns outline around text data labels chart . Enabling outline can improve readability complex similarly colored backgrounds. default, feature enabled (TRUE) expects logical value (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"datalabel_vertical_align","dir":"Articles","previous_headings":"","what":"datalabel_vertical_align","title":"theme options","text":"Specifies vertical alignment data labels chart. default alignment center, meaning labels centered vertically. possible values include top bottom, allowing labels align top bottom associated data points. expects character value (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"format_sample_cat","dir":"Articles","previous_headings":"","what":"format_sample_cat","title":"theme options","text":"Allows specifying categorical data formatted, whether convert uppercase, lowercase, etc. expects character value (hdtype Txt) default value NULL, means default formatting applied.","code":""},{"path":"/articles/theme_options.html","id":"format_sample_dat","dir":"Articles","previous_headings":"","what":"format_sample_dat","title":"theme options","text":"Used format date-type data allows specify date-type data formatted (example YYYY-MM-DD DD/MM/YYYY). expects character value (hdtype Txt) default value NULL, indicating specific formatting applied default.","code":""},{"path":"/articles/theme_options.html","id":"format_sample_num","dir":"Articles","previous_headings":"","what":"format_sample_num","title":"theme options","text":"Used set format numbers visualization. format specified axes, numbers use format specified argument. default value 1500 expects value type character (hdtype Txt).","code":""},{"path":"/articles/theme_options.html","id":"grid_color","dir":"Articles","previous_headings":"","what":"grid_color","title":"theme options","text":"Specifies overall color grid lines graph. parameter can affect X Y axis grid lines individual colors specified (grid_x_color, grid_y_color). default color #d1d9db, light gray. expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"grid_line_type","dir":"Articles","previous_headings":"","what":"grid_line_type","title":"theme options","text":"Specifies line style grid graph, solid, dotted, dashed lines. default style “Dot” dotted lines expects character value (hdtype Cat), options like “dot”, “line”, “dash”.","code":""},{"path":"/articles/theme_options.html","id":"grid_size","dir":"Articles","previous_headings":"","what":"grid_size","title":"theme options","text":"Specifies general size grid lines graph. default size 0.3. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"grid_x_color","dir":"Articles","previous_headings":"","what":"grid_x_color","title":"theme options","text":"Determines color grid lines corresponding X-axis chart. color crucial distinguishing divisions marks along X-axis. default color #d1d9db. expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"grid_x_line_type","dir":"Articles","previous_headings":"","what":"grid_x_line_type","title":"theme options","text":"Specifies line type (solid, dashed, etc.) grid X-axis. default, parameter set NULL. expects value type character (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"grid_x_show","dir":"Articles","previous_headings":"","what":"grid_x_show","title":"theme options","text":"Determines whether grid lines along X-axis displayed. set TRUE, grid lines shown. default value TRUE expects value type logical (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"grid_x_size","dir":"Articles","previous_headings":"","what":"grid_x_size","title":"theme options","text":"Specifies size grid lines associated X-axis chart. larger size makes grid lines noticeable. default value 0, indicating grid lines visible. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"grid_x_width","dir":"Articles","previous_headings":"","what":"grid_x_width","title":"theme options","text":"Specifies width grid lines corresponding X-axis chart. default value 1, indicating standard width grid lines. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"grid_y_color","dir":"Articles","previous_headings":"","what":"grid_y_color","title":"theme options","text":"Defines color grid lines along Y-axis chart. serves differentiate divisions marks Y-axis. default color #d1d9db. argument expects value type character (hdtype Clr)","code":""},{"path":"/articles/theme_options.html","id":"grid_y_line_type","dir":"Articles","previous_headings":"","what":"grid_y_line_type","title":"theme options","text":"Determines style grid lines along Y-axis. allows specify whether lines solid, dotted, dashed, another style. default value NULL, meaning line style explicitly set. argument expects value type character (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"grid_y_show","dir":"Articles","previous_headings":"","what":"grid_y_show","title":"theme options","text":"Controls visibility horizontal grid lines. set TRUE, grid lines along Y-axis displayed. set FALSE, horizontal grid lines displayed. default value TRUE, meaning grid lines shown. argument expects value type logical (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"grid_y_size","dir":"Articles","previous_headings":"","what":"grid_y_size","title":"theme options","text":"Specifies size horizontal grid lines (related Y-axis) graphic. default value NULL argument expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"grid_y_width","dir":"Articles","previous_headings":"","what":"grid_y_width","title":"theme options","text":"Specifies width grid lines corresponding Y-axis chart. default value 1, represents standard width. argument expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"highlight_values_color","dir":"Articles","previous_headings":"","what":"highlight_values_color","title":"theme options","text":"Specifies color used highlight specific values elements visualization. default color #50c5b7, shade teal. expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"legend_background","dir":"Articles","previous_headings":"","what":"legend_background","title":"theme options","text":"Specifies background color legend chart. default color transparent expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"legend_border_width","dir":"Articles","previous_headings":"","what":"legend_border_width","title":"theme options","text":"Specifies width border around legend. default value 0, means border displayed. Increasing value increase widht border. expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_margin","dir":"Articles","previous_headings":"","what":"legend_margin","title":"theme options","text":"Specifies width border around legend visualization. affects spacing legend elements graph edges visualization. default value 0 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_margin_bottom","dir":"Articles","previous_headings":"","what":"legend_margin_bottom","title":"theme options","text":"Specifies margin bottom legend visualization. default value NULL, meaning specific bottom margin applied. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_margin_left","dir":"Articles","previous_headings":"","what":"legend_margin_left","title":"theme options","text":"Specifies margin left legend visualization. default value NULL, meaning specific left margin applied. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_margin_right","dir":"Articles","previous_headings":"","what":"legend_margin_right","title":"theme options","text":"Specifies margin right legend visualization. default value NULL, meaning specific right margin applied. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_margin_top","dir":"Articles","previous_headings":"","what":"legend_margin_top","title":"theme options","text":"Adjusts top margin legend chart. default value NULL, meaning specific top margin applied. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_show","dir":"Articles","previous_headings":"","what":"legend_show","title":"theme options","text":"Ccontrols visibility legend chart. default value TRUE, meaning legend visible. expects value type logical (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_color","dir":"Articles","previous_headings":"","what":"legend_text_color","title":"theme options","text":"Specifies color text legend. default, color explicitly set (NULL). expects value type color (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_family","dir":"Articles","previous_headings":"","what":"legend_text_family","title":"theme options","text":"Specifies font family text legend. default font family IBM Plex Sans, providing clean modern look legend text. expects value type character (hdtype Fnt).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_horizontal_align","dir":"Articles","previous_headings":"","what":"legend_text_horizontal_align","title":"theme options","text":"Controls horizontal alignment text within legend box. default center, centers text horizontally. possible values include left right. expects value type character (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_margin","dir":"Articles","previous_headings":"","what":"legend_text_margin","title":"theme options","text":"Sets margin around text inside legend. default value isNULL, indicating specific margin set. expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_margin_bottom","dir":"Articles","previous_headings":"","what":"legend_text_margin_bottom","title":"theme options","text":"Defines margin space text item legend, useful controlling spacing arrangement elements within legend. default value 0. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_margin_left","dir":"Articles","previous_headings":"","what":"legend_text_margin_left","title":"theme options","text":"Defines margin left text within legend, controlling spacing alignment text inside legend. default value NULL, expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_margin_right","dir":"Articles","previous_headings":"","what":"legend_text_margin_right","title":"theme options","text":"Sets margin right text within legend, controlling spacing alignment text inside legend. default value NULL, expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_margin_top","dir":"Articles","previous_headings":"","what":"legend_text_margin_top","title":"theme options","text":"Sets margin space top text within legend, controlling spacing alignment text inside legend. default value 0, expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_size","dir":"Articles","previous_headings":"","what":"legend_text_size","title":"theme options","text":"Determines size text inside legend. default value 11, expects numeric value representing size points (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"legend_text_vertical_align","dir":"Articles","previous_headings":"","what":"legend_text_vertical_align","title":"theme options","text":"Specifies vertical alignment text within legend. default value center, vertically centers text. possible values include top bottom. expects value type character (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"line_color","dir":"Articles","previous_headings":"","what":"line_color","title":"theme options","text":"Allows customization line colors graph. default color #BEC7D0, light gray shade. parameter expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"line_marker","dir":"Articles","previous_headings":"","what":"line_marker","title":"theme options","text":"Controls visibility markers line chart. set TRUE, markers points, circles, squares (specified line_marker_type) displayed along lines. default value FALSE, meaning markers shown. parameter expects logical value (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"line_marker_size","dir":"Articles","previous_headings":"","what":"line_marker_size","title":"theme options","text":"Defines size markers line graph. Markers small symbols (circles, squares, triangles) placed data points along line. default size 4. parameter expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"line_size","dir":"Articles","previous_headings":"","what":"line_size","title":"theme options","text":"Defines thickness lines line chart.default size 0.5 parameter expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"locale","dir":"Articles","previous_headings":"","what":"locale","title":"theme options","text":"Defines regional settings affect data presented, date, currency, number format. default value en-US, corresponds English (United States). can specify locales format data according different regional conventions. parameter expects character value (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"logo","dir":"Articles","previous_headings":"","what":"logo","title":"theme options","text":"Specifies PNG, SVG, link logo added graph’s canvas. default value NULL, indicating logo added. parameter expects character type (hdtype Img).","code":""},{"path":"/articles/theme_options.html","id":"logo_height","dir":"Articles","previous_headings":"","what":"logo_height","title":"theme options","text":"Specifies height logo graph’s canvas. default value NULL, can provide numeric value set height logo pixels. parameter expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"logo_position","dir":"Articles","previous_headings":"","what":"logo_position","title":"theme options","text":"Defines position logo within chart’s canvas. default position “right,” indicating logo placed right side chart. can specify different position providing one following values: topleft topcenter topright centerleft centercenter centerright bottomleft bottomcenter bottomright parameter expects character value (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"logo_width","dir":"Articles","previous_headings":"","what":"logo_width","title":"theme options","text":"Defines width logo graph. default value NULL, means width specify logo displayed original size. can specify numeric value (hdtype Num) adjust width logo.","code":""},{"path":"/articles/theme_options.html","id":"map_graticule","dir":"Articles","previous_headings":"","what":"map_graticule","title":"theme options","text":"Controls display grid lines (meridians parallels) map geographic reference. set TRUE, grid displayed; set FALSE, hidden. default value FALSE parameter expects logical value (hdtype Chk).","code":""},{"path":"/articles/theme_options.html","id":"map_graticule_interval","dir":"Articles","previous_headings":"","what":"map_graticule_interval","title":"theme options","text":"Sets interval lines graticule map. lines typically represent meridians parallels aid geographic orientation. default value 5, meaning lines drawn every 5 degrees. parameter expects numeric value (hdtype Num) representing interval degrees.","code":""},{"path":"/articles/theme_options.html","id":"map_provider_tile","dir":"Articles","previous_headings":"","what":"map_provider_tile","title":"theme options","text":"Specifies tile provider used map backgrounds. default value “leaflet” expects value type character (hdtype Cat) representing tile provider’s name.","code":""},{"path":"/articles/theme_options.html","id":"plot_background_color","dir":"Articles","previous_headings":"","what":"plot_background_color","title":"theme options","text":"Defines background color plot area graph. default value NA, meaning specific color set. parameter expects value type character (hdtype Clr) representing color.","code":""},{"path":"/articles/theme_options.html","id":"plot_border_color","dir":"Articles","previous_headings":"","what":"plot_border_color","title":"theme options","text":"Defines color border around main plot area chart. default color #d1d9d, light gray color. parameter expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"plot_border_width","dir":"Articles","previous_headings":"","what":"plot_border_width","title":"theme options","text":"Determines width border around main plot area chart. default width 1 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"plot_margin_bottom","dir":"Articles","previous_headings":"","what":"plot_margin_bottom","title":"theme options","text":"Controls margin bottom plot area. affects space plot area elements chart edges visualization. default value NULL expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"plot_margin_left","dir":"Articles","previous_headings":"","what":"plot_margin_left","title":"theme options","text":"Controls margin left side plot area. affects space plot area elements chart edges visualization. default value NULL expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"plot_margin_right","dir":"Articles","previous_headings":"","what":"plot_margin_right","title":"theme options","text":"Controls margin right side plot area. Adjusting margin can useful ensure elements chart visible cramped. default value NA, expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"plot_margin_top","dir":"Articles","previous_headings":"","what":"plot_margin_top","title":"theme options","text":"Controls margin top plot area. default value 10, providing margin 10 units. parameter expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"subtitle_align","dir":"Articles","previous_headings":"","what":"subtitle_align","title":"theme options","text":"Determines alignment subtitle visualization. default alignment left type character (hdtype Cat), meaning accepts values “left”, “center”, “right”.","code":""},{"path":"/articles/theme_options.html","id":"subtitle_color","dir":"Articles","previous_headings":"","what":"subtitle_color","title":"theme options","text":"Defines color subtitle text visualization. can specify color using valid format. default color #28333f type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"subtitle_size","dir":"Articles","previous_headings":"","what":"subtitle_size","title":"theme options","text":"Specifies font size, points, subtitle text visualization. default size 17 points expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"subtitle_weight","dir":"Articles","previous_headings":"","what":"subtitle_weight","title":"theme options","text":"Specifies font weight subtitle text visualization.default weight 700, type character (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"table_table_background","dir":"Articles","previous_headings":"","what":"table_table_background+","title":"theme options","text":"Defines background color entire table. default color #ffffff, corresponds white. can change value customize background color table. parameter expects color value (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"text_color","dir":"Articles","previous_headings":"","what":"text_color","title":"theme options","text":"Specifies general text color visualization. default color #28333f, dark blue-gray. can change value customize text color throughout visualization. parameter expects color value (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"text_size","dir":"Articles","previous_headings":"","what":"text_size","title":"theme options","text":"Specifies general text size visualization. default size 12, can adjust value make text larger smaller throughout visualization. parameter expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"text_wrap","dir":"Articles","previous_headings":"","what":"text_wrap","title":"theme options","text":"Determines maximum number characters can appear single line text visualization. text string exceeds limit, wrap onto next line. default value 12, meaning text wrap 12 characters. parameter expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"title_align","dir":"Articles","previous_headings":"","what":"title_align","title":"theme options","text":"Controls alignment title within visualization. default, title aligned left, can adjust centered aligned right. expects value type numeric (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"title_axis_color","dir":"Articles","previous_headings":"","what":"title_axis_color","title":"theme options","text":"Specifies color text used axis titles chart. helps distinguish axis titles text visualization. default value NULL, indicating color explicitly set. expects value type character (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"title_axis_size","dir":"Articles","previous_headings":"","what":"title_axis_size","title":"theme options","text":"Defines font size axis titles graphic. default size 13 points, can specify values 1 20 points. type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"title_color","dir":"Articles","previous_headings":"","what":"title_color","title":"theme options","text":"Specifies color text used main title visualization. default color #28333f expects value type character(hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"title_family","dir":"Articles","previous_headings":"","what":"title_family","title":"theme options","text":"Specifies font family used main title visualization. default font family IBM Plex Sans expects value type character(hdtype Fnt).","code":""},{"path":"/articles/theme_options.html","id":"title_size","dir":"Articles","previous_headings":"","what":"title_size","title":"theme options","text":"Determines font size visualization’s title. default size 21 points can adjust value 1 20 points. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"title_weight","dir":"Articles","previous_headings":"","what":"title_weight","title":"theme options","text":"Specifies font weight visualization’s title. default weight 700 (bold style), can choose several options thin, light, regular, medium, bold, black. expects value type character (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"tooltip_background","dir":"Articles","previous_headings":"","what":"tooltip_background","title":"theme options","text":"Defines background color tooltips provide additional information hovering elements visualization. default color #ffffff (white), can customize color fit style visualization. parameter expects color value (hdtype Clr).","code":""},{"path":"/articles/theme_options.html","id":"tooltip_text_family","dir":"Articles","previous_headings":"","what":"tooltip_text_family","title":"theme options","text":"Defines font family used text inside tooltips. default NULL, means default font used. can specify font family available fonts list customize appearance tooltips. parameter expects character value (hdtype Fnt).","code":""},{"path":"/articles/theme_options.html","id":"tooltip_text_size","dir":"Articles","previous_headings":"","what":"tooltip_text_size","title":"theme options","text":"Sets font size text inside tooltips. default size 14 points, can specify size 1 20 points adjust text size tooltips. parameter expects numeric value representing font size (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"x_max","dir":"Articles","previous_headings":"","what":"x_max","title":"theme options","text":"Sets maximum value X-axis chart. determines upper limit X-axis, controlling range data displayed along axis. default value NULL expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"x_min","dir":"Articles","previous_headings":"","what":"x_min","title":"theme options","text":"Sets minimum value X-axis chart. determines lower limit X-axis, controlling range data displayed along axis. default value NULL expects numeric value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"y_axis_align","dir":"Articles","previous_headings":"","what":"y_axis_align","title":"theme options","text":"Specifies alignment Y-axis labels chart. can set “left”, “right”, “center” relative axis. default value NULL, means alignment determined automatically expects character values (hdtype Cat).","code":""},{"path":"/articles/theme_options.html","id":"y_max","dir":"Articles","previous_headings":"","what":"y_max","title":"theme options","text":"Set maximum value represented Y-axis chart. parameter allows focus visualization specific range interest defining upper limit Y-axis. default value NULL expects numerical value (hdtype Num).","code":""},{"path":"/articles/theme_options.html","id":"y_min","dir":"Articles","previous_headings":"","what":"y_min","title":"theme options","text":"Sets minimum value Y-axis chart. determines lower limit Y-axis, controlling range data displayed along axis. default value NULL expects numeric value (hdtype Num).","code":""},{"path":"/articles/titles_options.html","id":"caption","dir":"Articles","previous_headings":"","what":"caption","title":"titles options","text":"Provide descriptive explanatory text accompanies visualization, providing additional context data source. expects value type character (hdtype Txt).","code":""},{"path":"/articles/titles_options.html","id":"caption_align","dir":"Articles","previous_headings":"","what":"caption_align","title":"titles options","text":"Controls alignment credits visualization. default alignment “left” expects value type character (hdtype Cat).","code":""},{"path":"/articles/titles_options.html","id":"caption_color","dir":"Articles","previous_headings":"","what":"caption_color","title":"titles options","text":"Controls color text credits visualization. default color #28333f expects value type character (hdtype Clr).","code":""},{"path":"/articles/titles_options.html","id":"caption_link","dir":"Articles","previous_headings":"","what":"caption_link","title":"titles options","text":"Specify link associated credits graph. accepts values type character (hdtype Txt), valid URL can provided string. default value NULL.","code":""},{"path":"/articles/titles_options.html","id":"caption_margin","dir":"Articles","previous_headings":"","what":"caption_margin","title":"titles options","text":"Specifies margin around credits visualization. default value 15 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/titles_options.html","id":"caption_size","dir":"Articles","previous_headings":"","what":"caption_size","title":"titles options","text":"Specifies font size, points, text credits visualization. default value 12 expects value type numeric (hdtype Num).","code":""},{"path":"/articles/titles_options.html","id":"caption_weight","dir":"Articles","previous_headings":"","what":"caption_weight","title":"titles options","text":"Specifies font weight used credits visualization. higher weight corresponds bolder text. default value NULL expects value type character (hdtype Cat).","code":""},{"path":"/articles/titles_options.html","id":"subtitle","dir":"Articles","previous_headings":"","what":"subtitle","title":"titles options","text":"Defines secondary text offers additional information context visualization, typically positioned main title expects value type character (hdtype Txt).","code":""},{"path":"/articles/titles_options.html","id":"subtitle_align","dir":"Articles","previous_headings":"","what":"subtitle_align","title":"titles options","text":"Determines alignment subtitle visualization. default alignment left type character (hdtype Cat), meaning accepts values “left”, “center”, “right”.","code":""},{"path":"/articles/titles_options.html","id":"subtitle_color","dir":"Articles","previous_headings":"","what":"subtitle_color","title":"titles options","text":"Defines color subtitle text visualization. can specify color using valid format. default color #28333f type character (hdtype Clr).","code":""},{"path":"/articles/titles_options.html","id":"subtitle_size","dir":"Articles","previous_headings":"","what":"subtitle_size","title":"titles options","text":"Specifies font size, points, subtitle text visualization. default size 17 points expects value type numeric (hdtype Num).","code":""},{"path":"/articles/titles_options.html","id":"subtitle_weight","dir":"Articles","previous_headings":"","what":"subtitle_weight","title":"titles options","text":"Specifies font weight subtitle text visualization.default weight 700, type character (hdtype Cat).","code":""},{"path":"/articles/titles_options.html","id":"title","dir":"Articles","previous_headings":"","what":"title","title":"titles options","text":"Defines main title visualization, accepts characters values(hdtype Txt).","code":""},{"path":"/articles/titles_options.html","id":"title_align","dir":"Articles","previous_headings":"","what":"title_align","title":"titles options","text":"Controls alignment title within visualization. default, title aligned left, can adjust centered aligned right. expects value type numeric (hdtype Cat).","code":""},{"path":"/articles/titles_options.html","id":"title_axis_color","dir":"Articles","previous_headings":"","what":"title_axis_color","title":"titles options","text":"Specifies color text used axis titles chart. helps distinguish axis titles text visualization. default value NULL, indicating color explicitly set. expects value type character (hdtype Clr).","code":""},{"path":"/articles/titles_options.html","id":"title_axis_size","dir":"Articles","previous_headings":"","what":"title_axis_size","title":"titles options","text":"Defines font size axis titles graphic. default size 13 points, can specify values 1 20 points. type numeric (hdtype Num).","code":""},{"path":"/articles/titles_options.html","id":"title_color","dir":"Articles","previous_headings":"","what":"title_color","title":"titles options","text":"Specifies color text used main title visualization. default color #28333f expects value type character(hdtype Clr).","code":""},{"path":"/articles/titles_options.html","id":"title_family","dir":"Articles","previous_headings":"","what":"title_family","title":"titles options","text":"Specifies font family used main title visualization. default font family IBM Plex Sans expects value type character(hdtype Fnt).","code":""},{"path":"/articles/titles_options.html","id":"title_legend","dir":"Articles","previous_headings":"","what":"title_legend","title":"titles options","text":"Defines title legend visualization. legend helps viewers identify meaning color, shape, symbol used chart. type character (hdtype Txt).","code":""},{"path":"/articles/titles_options.html","id":"title_size","dir":"Articles","previous_headings":"","what":"title_size","title":"titles options","text":"Determines font size visualization’s title. default size 21 points can adjust value 1 20 points. expects value type numeric (hdtype Num).","code":""},{"path":"/articles/titles_options.html","id":"title_weight","dir":"Articles","previous_headings":"","what":"title_weight","title":"titles options","text":"Specifies font weight visualization’s title. default weight 700 (bold style), can choose several options thin, light, regular, medium, bold, black. expects value type character (hdtype Cat).","code":""},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Camila Achuri. Author, maintainer.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Achuri C (2024). dsopts: dsopts. R package version 0.0.0.9000.","code":"@Manual{, title = {dsopts: dsopts}, author = {Camila Achuri}, year = {2024}, note = {R package version 0.0.0.9000}, }"},{"path":"/index.html","id":"dsopts","dir":"","previous_headings":"","what":"dsopts ","title":"dsopts ","text":"goal dsopts provide set options used datasketch data visualization processing packages","code":""},{"path":"/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"dsopts ","text":"install development version dsopts GitHub :","code":"# install.packages(\"devtools\") devtools::install_github(\"datasketch/dsopts\")"},{"path":"/index.html","id":"examples","dir":"","previous_headings":"","what":"Examples","title":"dsopts ","text":"see available options use: dsopts_available() get defaults override defaults override defaults list options","code":"library(dsopts) ## basic example code # See all available options for a category dsopts_available(\"treemap\") #> [1] \"treemap_direction\" \"treemap_layers\" \"treemap_layers_params\" #> [4] \"treemap_layout\" # See all available options for a category dsopts_available(\"zoom\") #> [1] \"map_zoom_delta\" \"map_zoom_snap\" \"x_max\" \"y_max\" #> [5] \"zoom_level\" \"zoom_max\" \"zoom_min\" \"zoom_show\" # Can handle multiple categories # This returns the options with both categories dsopts_available(c(\"map\", \"bubble\")) #> [1] \"bubble_max\" \"bubble_min\" \"bubble_opacity\" # This returns the options with any of categories dsopts_available(c(\"map\", \"bubble\"), type = \"any_of\") #> [1] \"border_opacity\" \"bubble_max\" \"bubble_min\" #> [4] \"bubble_opacity\" \"map_bubble_cluster\" \"map_graticule\" #> [7] \"map_graticule_interval\" \"map_name\" \"map_name_layers_params\" #> [10] \"map_popup\" \"map_projection_params\" \"map_zoom_delta\" #> [13] \"map_zoom_snap\" \"zoom_level\" dsopts_default(categories = \"donut\") #> $donut_width #> [1] 2 #> #> $sort #> [1] \"no\" dsopts_merge(donut_width = 1, categories = \"donut\") #> $donut_width #> [1] 1 #> #> $sort #> [1] \"no\" opts <- list( donut_width = 2 ) dsopts_merge(donut_width = 1, opts = opts, categories = \"donut\") #> $donut_width #> [1] 2 #> #> $sort #> [1] \"no\""},{"path":"/reference/dsopts-package.html","id":null,"dir":"Reference","previous_headings":"","what":"dsopts: dsopts — dsopts-package","title":"dsopts: dsopts — dsopts-package","text":"package (one paragraph).","code":""},{"path":"/reference/dsopts-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"dsopts: dsopts — dsopts-package","text":"Maintainer: Camila Achuri first.last@example.com (ORCID)","code":""},{"path":"/reference/dsopts_available.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Available Options — dsopts_available","title":"Retrieve Available Options — dsopts_available","text":"function retrieves available options dsopts package, optionally filtered specified categories.","code":""},{"path":"/reference/dsopts_available.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Available Options — dsopts_available","text":"","code":"dsopts_available(categories = NULL, type = \"all_of\")"},{"path":"/reference/dsopts_available.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Available Options — dsopts_available","text":"categories vector character strings specifying categories options retrieve. NULL (default), categories considered. type character string specifying type filter apply categories specified. Default \"all_of\".","code":""},{"path":"/reference/dsopts_available.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Available Options — dsopts_available","text":"sorted vector names available options. categories specified, options categories returned.","code":""},{"path":"/reference/dsopts_available.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Available Options — dsopts_available","text":"","code":"if (FALSE) { # Assuming 'my_category' as a valid option category available_opts <- dsopts_available(categories = 'my_category') }"},{"path":"/reference/dsopts_default.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Default Options for a Specific Category — dsopts_default","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"function retrieves default options dsopts package specific category. category specified, returns default options categories.","code":""},{"path":"/reference/dsopts_default.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"","code":"dsopts_default(categories = NULL, type = \"all_of\")"},{"path":"/reference/dsopts_default.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"categories character string specifying category options retrieve. NULL (default), categories considered. type all_of any_of multiples categories provided","code":""},{"path":"/reference/dsopts_default.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"named list default options. category specified, options category returned.","code":""},{"path":"/reference/dsopts_default.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Default Options for a Specific Category — dsopts_default","text":"","code":"if (FALSE) { # Assuming 'category' as a valid option category default_opts <- dsopts_default(category = 'my_category') }"},{"path":"/reference/dsopts_merge.html","id":null,"dir":"Reference","previous_headings":"","what":"Merge Default and User-Defined Options — dsopts_merge","title":"Merge Default and User-Defined Options — dsopts_merge","text":"function merges user-defined options default options dsopts package. category specified, options category considered. User-defined options overwrite default ones.","code":""},{"path":"/reference/dsopts_merge.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Merge Default and User-Defined Options — dsopts_merge","text":"","code":"dsopts_merge(..., categories = NULL)"},{"path":"/reference/dsopts_merge.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Merge Default and User-Defined Options — dsopts_merge","text":"... User-defined options merge defaults. category character string specifying category options merge. NULL (default), categories considered.","code":""},{"path":"/reference/dsopts_merge.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Merge Default and User-Defined Options — dsopts_merge","text":"named list merged options. category specified, options category returned.","code":""},{"path":"/reference/dsopts_merge.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Merge Default and User-Defined Options — dsopts_merge","text":"","code":"if (FALSE) { # Assuming 'my_option' as a valid option name and 'my_category' as a valid option category merged_opts <- dsopts_merge(my_option = 'my_value', category = 'my_category') }"},{"path":"/reference/dsopt_default.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Default Option — dsopt_default","title":"Retrieve Default Option — dsopt_default","text":"function retrieves default value specified option dsopts package.","code":""},{"path":"/reference/dsopt_default.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Default Option — dsopt_default","text":"","code":"dsopt_default(opt)"},{"path":"/reference/dsopt_default.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Default Option — dsopt_default","text":"opt character string specifying name option whose default value retrieved.","code":""},{"path":"/reference/dsopt_default.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Default Option — dsopt_default","text":"default value specified option. option exist, returns NULL.","code":""},{"path":"/reference/dsopt_default.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Default Option — dsopt_default","text":"","code":"if (FALSE) { # Assuming 'my_option' as a valid option name default_opt <- dsopt_default(opt = 'my_option') }"}] diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 332121a..78ff28e 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -4,13 +4,25 @@ /404.html - /articles/argui.html + /articles/axis_options.html + + + /articles/colorprep_options.html + + + /articles/dataprep_options.html /articles/index.html - /articles/indexcat.html + /articles/index_categories.html + + + /articles/theme_options.html + + + /articles/titles_options.html /authors.html diff --git a/vignettes/axis_options.Rmd b/vignettes/axis_options.Rmd new file mode 100644 index 0000000..e9747d4 --- /dev/null +++ b/vignettes/axis_options.Rmd @@ -0,0 +1,120 @@ +--- +title: "axis options" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{axis options} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + + +This page aims to explain the options available in the axis category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. + +#### axis_flip + +Swaps the X and Y axes in a plot. By default, it is set to FALSE, meaning the axes are not flipped. When set to TRUE, the orientation of the plot changes. This argument expects a logical values (hdtype Chk). + +#### axis_line_x_size + +Specifies the size or thickness of the X-axis line in a plot. The default size is 0 and It expects a value of type numeric (hdtype Num). + +#### axis_reversed + +Reverses the axes of the plot, such as flipping the Y-axis so that higher values appear at the bottom.The default value is FALSE, meaning the axes are not reversed. Its value type is logical (hdtype Chk), with possible values of TRUE or FALSE. + +#### axis_text_angle + +Specifies the angle of the axis text in a graphic. This can help improve readability when there are many labels or when labels are long. The default angle is 0 degrees, which means the text is horizontal.You can specify an angle between -90 and 90 degrees to rotate the text. It expects a value of type numeric (hdtype Num). + +#### axis_text_wrap + +Specifies the number of words to wrap in axis labels before wrapping onto the next line. By default, it is set to 6, so axis labels will wrap to the next line after 6 words. This allows long labels to be displayed on multiple lines, improving readability. It expects a value of type numeric (hdtype Num). + +#### axis_x_reversed + +Reverses the order of the data on the X-axis of a chart. When set to True, the highest values appear on the left and the lowest values on the right. It expects a value of type logical (hdtype Chk). + +#### axis_x_text_angle + +Specifies the angle of the labels on the X-axis in a chart.The default value is NULL, which means no rotation is applied. Also, you can specify an angle between -90 and 90 degrees to rotate the text. It expects a value of type numeric (hdtype Num). + +#### axis_x_text_wrap + +Specifies the number of words in the labels on the X-axis in a chart. This allows long labels to be displayed on multiple lines and avoids text overlap. The default value is NULL, indicating that no word wrapping is applied. It expects a value of type numeric (hdtype Num). + +#### axis_y_reversed + +Inverts the axes of the chart (e.g., reverses the Y-axis so that higher values are closer to the origin). If the chart is flipped, the X-axis is reversed by default and means that the order of the data on the Y-axis is reversed. The default value is FALSE, indicating that the axes are not reversed. It expects a value of type logical (hdtype Chk). + +#### axis_y_text_angle + +Controls the angle of the labels on the Y-axis. The default value is NULL, which means no rotation is applied. The angle can range from -90 to 90 degrees. It expects a value of type numeric (hdtype Num). + +#### axis_y_text_wrap + +Specifies the number of words in the labels of the Y-axis in a chart. This parameter allows long labels to be displayed on multiple lines, preventing text overlap. The default value is NULL, indicating that no word wrapping is applied. It expects a value of type numeric (hdtype Num). + +#### title_axis_color + +Specifies the color of the text used for the axis titles in a chart. This helps distinguish the axis titles from other text in the visualization. The default value is NULL, indicating that the color is not explicitly set. It expects a value of type character (hdtype Clr). + +#### title_axis_size + +Defines the font size for the axis titles in a graphic. The default size is 13 points, and you can specify values from 1 to 20 points. It expects a value of type numeric (hdtype Num). + +#### title_axis_x + +Specifies the title for the X-axis of a chart, describing the variable or data represented on the horizontal axis. It expects a value of type character (hdtype Txt). + +#### title_axis_y + +Specifies the title for the Y-axis of a chart, describing the variable or data represented on the vertical axis. It expects a value of type character (hdtype Txt). + +#### title_axis_y2 + +Specifies the title for the secondary Y-axis in a chart. In charts with two Y-axes, each axis can represent different types of data or scales, and this title would help identify the nature of the data represented by the secondary Y-axis. The default value is NULL and the argument expects a value of type character (hdtype Txt). + diff --git a/vignettes/colorprep_options.Rmd b/vignettes/colorprep_options.Rmd new file mode 100644 index 0000000..920429f --- /dev/null +++ b/vignettes/colorprep_options.Rmd @@ -0,0 +1,85 @@ +--- +title: "colorprep options" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{colorprep options} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + + + +This page aims to explain the options available in the colorprep category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. + +#### color_by + +Specifies the variable used to color elements in a visualization. It determines how elements are colored based on different categories or groups. When set to NULL, a default color scale is often applied, and expects a character value (hdtype Txt) representing the variable name. + +#### color_palette_categorical + +Specifies the color palette used for categorical data where each category is represented by a different color. This argument takes a list of colors (hdtype Lst[Clr]) in any valid format. By default, it has the value `list(#385573, #ffa92a, #f06142, #99e8b3, #32a8ce, #996295, #e59fd7)`. + +#### color_palette_divergening + +Specifies the color palette used to represent diverging data, where colors represent two opposite extremes or value ranges, such as hot/cold, high/low, etc. The argument expects a list of colors (hdtype Lst[Clr]) in any valid format. By default, it is set to list(#ff844e, #ffa154, #ffc48b, #eef0f1, #a0c7da, #57a0c5, #255b89). + +#### color_palette_sequential + +Specifies the color palette used for sequential data, where every color represent a sequence or gradient. Typically used to show intensity or magnitude. It received a list of colors (hdtype Lst[Clr]) in any valid format, its default value is `list(#b8f3ca, #add79c, #8dbd93, #70a38e, #568989, #3f6f83, #28557d)`. + +#### color_palette_type + +Specifies the type of color palette to be used in the visualization. It defaults to NULL and its possible values include "categorical," "sequential," and "diverging" (hdtype Cat). + +#### highlight_values_color + +Specifies the color used to highlight specific values or elements in the visualization. The default color is #50c5b7, and it expects a value of type character (hdtype Clr), which can be specified in any valid color format. + +#### na_color + +Specifies the color used to represent missing or "NA" (Not Available) data. The default color is #cbcdcf, and it expects a value of type character (hdtype Clr), which can be specified in any valid color format. diff --git a/vignettes/dataprep_options.Rmd b/vignettes/dataprep_options.Rmd index 3dc262a..8c1018c 100644 --- a/vignettes/dataprep_options.Rmd +++ b/vignettes/dataprep_options.Rmd @@ -54,77 +54,76 @@ vignette: > -This document aims to explain the options available in the dataprep category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. +This page aims to explain the options available in the dataprep category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. #### agg -Determines how data is summarized or combined (e.g., sums, averages, maximums, minimums). It expects a character value specifying the aggregation function (mean, max, min, etc.). Its default value is "sum," and its hd_type is Categorical (Cat). - +Determines how data is summarized or combined (e.g., sums, averages, maximums, minimums). It expects a character value (hdtype Cat) specifying the aggregation function (mean, max, min, etc.). Its default value is "sum". #### agg_na_rm -Indicates whether missing values (NA) should be removed before aggregating data. It expects a value of type logical, which represents boolean values (with possible values being True or False). By default, its value is TRUE, and its hd_type is Check (Chk). +Indicates whether missing values (NA) should be removed before aggregating data. It expects a value of type logical, which represents boolean values (hdtype Chk) True or False and by default, its value is TRUE. #### agg_text -Used as a label in the column name indicating the type of aggregation performed on the data. It has a default value of NULL and an hd_type of Txt (Text). Possible values include 'sum VAR,' 'mean VAR,' 'max VAR,' indicating the aggregation type (summed, averaged, or maximum value taken) for the data in the column. +Used as a label in the column name indicating the type of aggregation performed on the data. It expects a character value (hdtype Txt) and has a default value of NULL. Possible values include 'sum VAR,' 'mean VAR,' 'max VAR,' indicating the aggregation type (summed, averaged, or maximum value taken) for the data in the column. #### drop_na -Enhances the clarity of visual representations by excluding missing data (NA) when set to TRUE. Its hdtype is Chk (Check), expecting a logical value (TRUE or FALSE) and by default, its value is FALSE. +Enhances the clarity of visual representations by excluding missing data (NA) when set to TRUE. It expects a logical value (hdtype Chk) TRUE or FALSE, and by default, its value is FALSE. #### drop_na_var2 -Removes missing data (NA) from a second variable in the visualization. Its default value is FALSE, its `hdtype` is Chk (Check), and its possible values are TRUE or FALSE. +Removes missing data (NA) from a second variable in the visualization. Its default value is FALSE and its possible values are TRUE or FALSE (hdtype Chk). #### format_number_prefix -Formats numeric values using SI prefixes to represent large numbers in a more readable format such as k (thousands), M (millions) in numeric values.It expects a logical value (TRUE or FALSE), with a default value of FALSE and an hdtype of chk (Check). +Formats numeric values using SI prefixes to represent large numbers in a more readable format such as k (thousands), M (millions) in numeric values. It expects a logical value (hdtype Chk) TRUE or FALSE, with a default value of FALSE. #### format_sample_cat -Allows specifying how categorical data should be formatted, such as whether to convert them to uppercase, lowercase, etc. Its `hdtype` is Txt (text) and Its default value is NULL, which means no default formatting is applied. +Allows specifying how categorical data should be formatted, such as whether to convert them to uppercase, lowercase, etc. It expects a character value (hdtype Txt) and its default value is NULL, which means no default formatting is applied. #### format_sample_dat -Used to format date-type data and allows to specify how date-type data should be formatted (for example YYYY-MM-DD or DD/MM/YYYY). its hdtype is Txt (text) and the default value is NULL, indicating that no specific formatting is applied by default. +Used to format date-type data and allows to specify how date-type data should be formatted (for example YYYY-MM-DD or DD/MM/YYYY). It expects a character value (hdtype Txt) and the default value is NULL, indicating that no specific formatting is applied by default. #### format_sample_num -Used to set the format for numbers in the visualization. If no format is specified for axes, all numbers will use the format specified by this argument. The default value is 1500(Review) and this argument expects a `character` type (Review). +Used to set the format for numbers in the visualization. If no format is specified for axes, all numbers will use the format specified by this argument. The default value is 1500 and this argument expects a `character` type (hdtype Txt). #### na_label -Replaces NA values in a dataset with a specified label. For example, setting na_label = "Not Available" would display "Not Available" instead of NA in the visual representation of the data. It has an hdtype of Txt (text) and expects a character type value. +Replaces NA values in a dataset with a specified label. For example, setting na_label = "Not Available" would display "Not Available" instead of NA in the visual representation of the data. It expects a character type value (hdtype Txt). #### percentage -Calculates the percentage for the indicated numerical variable. Its default value is FALSE, its `hdtype` is chk (check) and this argument expects a logical value (TRUE or FALSE) +Calculates the percentage for the indicated numerical variable. Its default value is FALSE and this argument expects a logical value (hdtype Chk) TRUE or FALSE. #### percentage_col -Specifies the name or names of the categorical variable(s) for which you want to calculate percentages. For example, if you have a dataset with columns "category" and "value" representing different categories and their corresponding values, you can use percentage_col = "category" to calculate the percentage of each category. Its default value is NULL, and its `hdtype` is Txt (text). +Specifies the name or names of the categorical variable(s) for which you want to calculate percentages. For example, if you have a dataset with columns "category" and "value" representing different categories and their corresponding values, you can use percentage_col = "category" to calculate the percentage of each category. Its default value is NULL, and expects a character value (hdtype Txt). #### percentage_intra -Calculates percentages within individual categories or groups in a visualization. Defaulting to FALSE, with a expect logical value and its hdtype is Chk (Check). +Calculates percentages within individual categories or groups in a visualization. Defaulting to FALSE, with a expect logical value TRUE or FALSE (hdtype Chk). #### percentage_name -Specifies a character value that will be used as the name for the column containing the calculated percentages. It is used to provide a more descriptive name for the percentage column in the output visualization or dataset if `percentage` is TRUE. Its `hdtype` is Txt (text) and the type of the input is character (text). +Specifies a character value that will be used as the name for the column containing the calculated percentages. It provides a more descriptive name for the percentage column in the output visualization or dataset. By default, the value is NULL and The type value is character (hdtype Txt). #### tooltip_agg_collapse_rows_template -Controls the aggregation of data in tooltips, determining whether similar or related rows are collapsed into a single entry in the tooltip to avoid repetition. It takes a dataframe and a template as inputs and returns a column of strings with the applied template. The template can apply different aggregations such as mean or max. Its `hdtype` is Cat (categorical) and Its possible values are functions such as sum, mean, etc., which are used to specify the type of aggregation for the tooltip. +Controls the aggregation of data in tooltips, determining whether similar or related rows are collapsed into a single entry in the tooltip to avoid repetition. It takes a dataframe and a template as inputs and returns a column of strings with the applied template. The template can apply different aggregations such as mean or max. The template can apply different aggregations such as mean or max. Its possible values are functions such as sum, mean, etc (hdtype Cat) which are used to specify the type of aggregation for the tooltip. #### tooltip_include_all_vars -Includes all available variables in the entered dataframe for visualization. It has a default value of FALSE and Its `hdtype` is Chk (Check). +Includes all available variables in the entered dataframe for visualization. It has a default value of FALSE and and expects a logical value TRUE or FALSE (hdtype Chk). #### tooltip_sep_all_vars -Specifies the separator used in tooltips when multiple variables are included, allowing for clear separation and organization of information. Its `hdtype` is Cat (categorical). +Specifies the separator used in tooltips when multiple variables are included, allowing for clear separation and organization of information. It expects a character value (hdtype Cat). #### tooltip_template -Used as a customization template for tooltips, this template allows you to customize the content and format of tooltips in a visualization, using specific variables from the dataframe to display detailed and relevant information when hovering over elements of the visualization.Its hdtype is Txt (text), and the possible values are text that match the names of variables in the dataframe. +Used as a customization template for tooltips, this template allows you to customize the content and format of tooltips in a visualization, using specific variables from the dataframe to display detailed and relevant information when hovering over elements of the visualization. The possible values are character (hdtype Txt) that match the names of variables in the dataframe. diff --git a/vignettes/index_categories.Rmd b/vignettes/index_categories.Rmd index af02cc6..1d58942 100644 --- a/vignettes/index_categories.Rmd +++ b/vignettes/index_categories.Rmd @@ -52,16 +52,11 @@ vignette: > } -This section provides an overview of all the categories in which specific arguments are classified. - -```{r setup, include = FALSE} -knitr::opts_chunk$set( - collapse = TRUE, - comment = "#>" -) -``` - +* [axis](axis_options.html) +* [colorprep](colorprep_options.html) * [dataprep](dataprep_options.html) +* [theme](theme_options.html) +* [titles](titles_options.html) diff --git a/vignettes/theme_options.Rmd b/vignettes/theme_options.Rmd new file mode 100644 index 0000000..0a1a2f7 --- /dev/null +++ b/vignettes/theme_options.Rmd @@ -0,0 +1,817 @@ +--- +title: "theme options" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{theme options} + %\VignetteEncoding{UTF-8} + %\VignetteEngine{knitr::rmarkdown} +editor_options: + markdown: + wrap: 72 +--- + +```{=html} + +``` +This page aims to explain the options available in the theme category. It +will discuss the purpose of each argument, the possible values it can +take, and the expected outcome of each argument. + +#### animation_duration + +Specifies the duration of animations in the visualization, in +milliseconds. The default value is 0, indicating no animation. It +expects a value of type numeric (hdtype Num) in the range [0, 3000] +milliseconds. + +#### axis_line_color + +Specifies the color of the axis lines in a graphic. The default color is +`#7e858c`. It expects a value of type character (hdtype Clr). + +#### axis_line_size + +Controls the thickness of the axis lines in a graphic. A larger size +makes the axes more prominent, helping to emphasize them within the +visualization. The default value is NA, which means the size is not +explicitly set. It expects a value of type numeric (hdtype Num). + +#### axis_line_x_size + +Specifies the size or thickness of the X-axis line in a plot. The +default size is 0 and It expects a value of type numeric (hdtype Num). + +#### axis_line_y_size + +Specifies the size or thickness of the Y-axis line in a plot. The +default size is 1 and It expects a value of type numeric (hdtype Num). + +#### axis_margin_x + +Controls the margin on the X-axis of the graphic. Which is the space +between the edge of the chart area and the data points. A larger margin +provides breathing room for the data points, preventing them from +getting too close to the axis lines or the edge of the chart. The +default value is NULL and it expects a value of type numeric (hdtype +Num). + +#### axis_margin_y + +Controls the margin around the Y-axis in the graphic, which is the space +between the edge of the chart area and the data points along the Y-axis. +The default value is NA and it expects a value of type numeric (hdtype +Num). + +#### axis_show + +Controls the visibility of the axes in a graphic. By default, it is set +to FALSE, meaning the axes are not shown. It expects a logical value +(hdtype Chk). + +#### axis_tick_length + +Specifies the length of the tick marks along the axes of a chart. These +small lines help indicate specific values on the axes. The default +length is 10 and it expects a value of type numeric (hdtype Num). + +#### axis_ticks_color + +Determines the color of the tick marks along the axes of a chart. If +set, this color is applied to the small lines that indicate specific +values on the axes. The default value is NA and this argument expects a +value of type character (hdtype Clr). + +#### background_color + +Specifies the background color for the entire visualization. The default +color is #fafafa, which provides a neutral and clean background. It +expects a value of type character (hdtype Clr). + +#### bar_padding + +Specifies the spacing between bars in a bar chart. The default value is +0. This parameter can change the overall appearance of the chart, making +it more compact or more spaced out. It expects a numeric value (hdtype +Num). + +#### bar_width + +Specifies the width of the bars in a bar chart. Adjusting this parameter +can visually impact the chart's appearance, making it more compact or +more spaced out. The default value is 0 and it expects a numeric value +(hdtype Num). + +#### border_color + +Specifies the color of the border around the visualization. The default +value is NULL, indicating no border color is set. It expects a value of +type character (hdtype Clr). + +#### branding_background_color + +Specifies the background color for the area of the visualization +dedicated to the logo. The default value is NULL, but you can specify +the color using any valid format. It expects a value of type character +(hdtype Clr). + +#### branding_include + +Controls the presence of the logo in the visualization. By default, it +is set to FALSE, indicating that the logo is not included.It expects a +logical value (hdtype Chk), either TRUE or FALSE. + +#### branding_text + +Specifies the text used for the footer or logo space. By default, it is +set to "Created with Datasketch ". You can +customize this text to include your own branding or attribution +information. It expects a value of type character (hdtype Txt). + +#### caption + +Provide a descriptive or explanatory text that accompanies a +visualization, providing additional context such as the data source. It +expects a value of type character (hdtype Txt). + +#### caption_align + +Controls the alignment of the credits in the visualization. The default +alignment is "left" and it expects a value of type character (hdtype +Cat). + +#### caption_color + +Controls the color of the text for the credits in the visualization. The +default color is #28333f and it expects a value of type character +(hdtype Clr). + +#### caption_link + +Specify a link associated with the credits of the graph. It accepts +values of type character (hdtype Txt), where a valid URL can be provided +as a string. The default value is NULL. + +#### caption_margin + +Specifies the margin around the credits of the visualization. The +default value is 15 and its it expects a value of type numeric (hdtype +Num). + +#### caption_size + +Specifies the font size, in points, of the text in the credits of the +visualization. The default value is 12 and it expects a value of type +numeric (hdtype Num). + +#### caption_weight + +Specifies the font weight used for the credits in a visualization. A +higher weight corresponds to a bolder text. The default value is NULL +and it expects a value of type character (hdtype Cat). + +#### color_bins + +This option divides the data into categories based on color ranges. This +feature is particularly useful for creating heatmaps or graphs that +depend on the intensity of values. By default, it is set to NULL and it +expects a logical value (hdtype Chk). + +#### color_bins_method + +Determines how data is grouped into bins (intervals) based on their +values and assigned colors in graphs like heatmaps or histograms. Common +methods include "quantile," "equal," "k-means," and others, influencing +the distribution of data into color categories. The default value is +NULL, expecting a character value (hdtype Cat). + +#### color_palette_categorical + +Specifies the color palette used for categorical data where each +category is represented by a different color. This argument takes a list +of colors (hdtype Lst[Clr]) in any valid format. By default, it has the +value +`list(#385573, #ffa92a, #f06142, #99e8b3, #32a8ce, #996295, #e59fd7)`. + +#### color_palette_divergening + +Specifies the color palette used to represent diverging data, where +colors represent two opposite extremes or value ranges, such as +hot/cold, high/low, etc. The argument expects a list of colors (hdtype +Lst[Clr]) in any valid format. By default, it is set to `list(#ff844e,#ffa154, #ffc48b, #eef0f1, #a0c7da, #57a0c5, #255b89)`. + +#### color_palette_sequential + +Specifies the color palette used for sequential data, where every color +represent a sequence or gradient. Typically used to show intensity or +magnitude. It received a list of colors (hdtype Lst[Clr]) in any valid +format, its default value is +`list(#b8f3ca, #add79c, #8dbd93, #70a38e, #568989, #3f6f83, #28557d)`. + +#### datalabel_color + +Specifies the color of the text for data labels. By default, it is NULL +and it expects a value of type character (hdtype Clr). + +#### datalabel_format_sample + +Specifies the format of the data labels. By default, it is NULL and it +expects a value of type character (hdtype Txt). + +#### datalabel_formmater_js + +Specifies a JavaScript function to customize the format of the data +labels. By default, it is set to FALSE, indicating that no custom +formatting function is applied. This argument expects a logical value +(hdtype Chk). + +#### datalabel_horizontal_align + +Determines the horizontal alignment of the data labels in a graph. By +default, it is set to center, meaning the labels are centered +horizontally. This argument expects a character value (hdtype Cat), with +possible values of center, right, and left. + +#### datalabel_offset + +Specifies the offset of the data labels. It is used to adjust the +position of labels that display information about specific data points, +such as values or names. The default value is 0, which means no offset. +It expects a numeric value (hdtype Num). + +#### datalabel_offset_x + +Specifies the horizontal offset of data labels. This adjustment helps +prevent label overlap and enhances readability. The default value is +1.1, which provides a slight rightward shift to the labels. It expects a +numeric value (hdtype Num). + +#### datalabel_offset_y + +Adjusts the vertical position (Y-axis) of data labels in a graph, +helping to prevent text overlap. By default, this value is NULL, +allowing labels to be automatically positioned. It expects a numeric +value (hdtype Num). + +#### datalabel_size + +Specifies the font size of data labels in a graph. The default value is +NULL and it expects a numeric value (hdtype Num). + +#### datalabel_text_outline_show + +Turns the outline around the text of data labels on the chart on or off. +Enabling outline can improve readability against complex or similarly +colored backgrounds. By default, this feature is enabled (TRUE) and +expects a logical value (hdtype Chk). + +#### datalabel_vertical_align + +Specifies the vertical alignment of data labels in a chart. The default +alignment is center, meaning labels are centered vertically. Other +possible values include top and bottom, allowing labels to align at the +top or bottom of the associated data points. It expects a character +value (hdtype Cat). + +#### format_sample_cat + +Allows specifying how categorical data should be formatted, such as +whether to convert them to uppercase, lowercase, etc. It expects a +character value (hdtype Txt) and its default value is NULL, which means +no default formatting is applied. + +#### format_sample_dat + +Used to format date-type data and allows to specify how date-type data +should be formatted (for example YYYY-MM-DD or DD/MM/YYYY). It expects a +character value (hdtype Txt) and the default value is NULL, indicating +that no specific formatting is applied by default. + +#### format_sample_num + +Used to set the format for numbers in the visualization. If no format is +specified for axes, all numbers will use the format specified by this +argument. The default value is 1500 and this expects a value of type +character (hdtype Txt). + +#### grid_color + +Specifies the overall color of the grid lines in a graph. This parameter +can affect both the X and Y axis grid lines if individual colors are not +specified (grid_x_color, grid_y_color). The default color is #d1d9db, +which is a light gray. It expects a value of type character (hdtype +Clr). + +#### grid_line_type + +Specifies the line style for the grid in a graph, such as solid, dotted, +or dashed lines. The default style is "Dot" for dotted lines It expects +a character value (hdtype Cat), with options like "dot", "line", and +"dash". + +#### grid_size + +Specifies the general size of the grid lines in a graph. The default +size is 0.3. it expects a value of type numeric (hdtype Num). + +#### grid_x_color + +Determines the color of the grid lines corresponding to the X-axis in a +chart. This color is crucial for distinguishing the divisions or marks +along the X-axis. The default color is #d1d9db. it expects a value of +type character (hdtype Clr). + +#### grid_x_line_type + +Specifies the line type (solid, dashed, etc.) for the grid on the +X-axis. By default, this parameter is set to NULL. it expects a value of +type character (hdtype Cat). + +#### grid_x_show + +Determines whether the grid lines along the X-axis are displayed. When +set to TRUE, the grid lines are shown. The default value is TRUE and it +expects a value of type logical (hdtype Chk). + +#### grid_x_size + +Specifies the size of the grid lines associated with the X-axis in a +chart. A larger size makes the grid lines more noticeable. The default +value is 0, indicating that the grid lines are not visible. it expects a +value of type numeric (hdtype Num). + +#### grid_x_width + +Specifies the width of the grid lines corresponding to the X-axis in a +chart. The default value is 1, indicating a standard width for the grid +lines. It expects a value of type numeric (hdtype Num). + +#### grid_y_color + +Defines the color of the grid lines along the Y-axis in a chart. It +serves to differentiate the divisions or marks on the Y-axis. The +default color is #d1d9db. This argument expects a value of type +character (hdtype Clr) + +#### grid_y_line_type + +Determines the style of the grid lines along the Y-axis. It allows you +to specify whether the lines should be solid, dotted, dashed, or another +style. The default value is NULL, meaning the line style is not +explicitly set. This argument expects a value of type character (hdtype +Cat). + +#### grid_y_show + +Controls the visibility of the horizontal grid lines. When set to TRUE, +the grid lines along the Y-axis are displayed. If set to FALSE, the +horizontal grid lines will not be displayed. The default value is TRUE, +meaning the grid lines are shown. This argument expects a value of type +logical (hdtype Chk). + +#### grid_y_size + +Specifies the size of the horizontal grid lines (related to the Y-axis) +in a graphic. The default value is NULL and this argument expects a +value of type numeric (hdtype Num). + +#### grid_y_width + +Specifies the width of the grid lines corresponding to the Y-axis in a +chart. The default value is 1, which represents a standard width. This +argument expects a value of type numeric (hdtype Num). + +#### highlight_values_color + +Specifies the color used to highlight specific values or elements in the +visualization. The default color is #50c5b7, which is a shade of teal. +It expects a value of type character (hdtype Clr). + +#### legend_background + +Specifies the background color of the legend in the chart. The default +color is transparent and it expects a value of type character (hdtype +Clr). + +#### legend_border_width + +Specifies the width of the border around the legend. The default value +is 0, which means no border is displayed. Increasing the value will +increase the widht of the border. It expects a numeric value (hdtype +Num). + +#### legend_margin + +Specifies the width of the border around the legend in a visualization. +This affects the spacing between the legend and other elements of the +graph or the edges of the visualization. The default value is 0 and it +expects a value of type numeric (hdtype Num). + +#### legend_margin_bottom + +Specifies the margin at the bottom of the legend in a visualization. The +default value is NULL, meaning no specific bottom margin is applied. It +expects a value of type numeric (hdtype Num). + +#### legend_margin_left + +Specifies the margin to the left of the legend in a visualization. The +default value is NULL, meaning no specific left margin is applied. It +expects a value of type numeric (hdtype Num). + +#### legend_margin_right + +Specifies the margin to the right of the legend in a visualization. The +default value is NULL, meaning no specific right margin is applied. It +expects a value of type numeric (hdtype Num). + +#### legend_margin_top + +Adjusts the top margin of the legend in the chart. The default value is +NULL, meaning no specific top margin is applied. It expects a value of +type numeric (hdtype Num). + +#### legend_show + +Ccontrols the visibility of the legend in a chart. The default value is +TRUE, meaning the legend is visible. It expects a value of type logical +(hdtype Chk). + +#### legend_text_color + +Specifies the color of the text in the legend. By default, the color is +not explicitly set (NULL). It expects a value of type color (hdtype +Clr). + +#### legend_text_family + +Specifies the font family for the text in the legend. The default font +family is IBM Plex Sans, providing a clean and modern look for the +legend text. It expects a value of type character (hdtype Fnt). + +#### legend_text_horizontal_align + +Controls the horizontal alignment of the text within the legend box. The +default is center, which centers the text horizontally. Other possible +values include left and right. It expects a value of type character +(hdtype Cat). + +#### legend_text_margin + +Sets the margin around the text inside the legend. The default value +isNULL, indicating no specific margin is set. It expects a numeric value +(hdtype Num). + +#### legend_text_margin_bottom + +Defines the margin or space below the text of each item in the legend, +useful for controlling the spacing and arrangement of elements within +the legend. The default value is 0. It expects a value of type numeric +(hdtype Num). + +#### legend_text_margin_left + +Defines the margin to the left of the text within the legend, +controlling the spacing and alignment of the text inside the legend. Its +default value is NULL, and it expects a numeric value (hdtype Num). + +#### legend_text_margin_right + +Sets the margin to the right of the text within the legend, controlling +the spacing and alignment of the text inside the legend. Its default +value is NULL, and it expects a numeric value (hdtype Num). + +#### legend_text_margin_top + +Sets the margin or space at the top of the text within the legend, +controlling the spacing and alignment of the text inside the legend. Its +default value is 0, and it expects a numeric value (hdtype Num). + +#### legend_text_size + +Determines the size of the text inside the legend. Its default value is +11, and it expects a numeric value representing the size in points +(hdtype Num). + +#### legend_text_vertical_align + +Specifies the vertical alignment of the text within the legend. The +default value is center, which vertically centers the text. Other +possible values include top and bottom. It expects a value of type +character (hdtype Cat). + +#### line_color + +Allows for the customization of line colors in a graph. The default +color is #BEC7D0, a light gray shade. This parameter expects a value of +type character (hdtype Clr). + +#### line_marker + +Controls the visibility of markers in a line chart. When set to TRUE, +markers such as points, circles, or squares (as specified by +line_marker_type) are displayed along the lines. The default value is +FALSE, meaning that markers are not shown. This parameter expects a +logical value (hdtype Chk). + +#### line_marker_size + +Defines the size of markers in a line graph. Markers are small symbols +(such as circles, squares, triangles) placed at data points along the +line. The default size is 4. This parameter expects a numeric value +(hdtype Num). + +#### line_size + +Defines the thickness of the lines in a line chart.The default size is +0.5 and this parameter expects a numeric value (hdtype Num). + +#### locale + +Defines the regional settings that affect how data is presented, such as +date, currency, and number format. The default value is en-US, which +corresponds to English (United States). You can specify other locales to +format your data according to different regional conventions. This +parameter expects a character value (hdtype Cat). + +#### logo + +Specifies the PNG, SVG, or link of the logo to be added to the graph's +canvas. The default value is NULL, indicating that no logo is added. +This parameter expects a character type (hdtype Img). + +#### logo_height + +Specifies the height of the logo in the graph's canvas. The default +value is NULL, but you can provide a numeric value to set the height of +the logo in pixels. This parameter expects a numeric value (hdtype Num). + +#### logo_position + +Defines the position of the logo within the chart's canvas. The default +position is "right," indicating that the logo is placed on the right +side of the chart. You can specify a different position by providing one +of the following values: + +- topleft + +- topcenter + +- topright + +- centerleft + +- centercenter + +- centerright + +- bottomleft + +- bottomcenter + +- bottomright + +This parameter expects a character value (hdtype Cat). + +#### logo_width + +Defines the width of the logo in the graph. The default value is NULL, +which means that the width is not specify and the logo will be displayed +at its original size. You can specify a numeric value (hdtype Num) to +adjust the width of the logo. + +#### map_graticule + +Controls the display of a grid of lines (meridians and parallels) on a +map for geographic reference. When set to TRUE, the grid is displayed; +when set to FALSE, it is hidden. The default value is FALSE and this +parameter expects a logical value (hdtype Chk). + +#### map_graticule_interval + +Sets the interval between lines of the graticule on a map. These lines +typically represent meridians and parallels to aid in geographic +orientation. The default value is 5, meaning that lines are drawn every +5 degrees. This parameter expects a numeric value (hdtype Num) +representing the interval in degrees. + +#### map_provider_tile + +Specifies the tile provider used for map backgrounds. The default value +is "leaflet" and expects a value of type character (hdtype Cat) +representing the tile provider's name. + +#### plot_background_color + +Defines the background color of the plot area in a graph. The default +value is NA, meaning no specific color is set. This parameter expects a +value of type character (hdtype Clr) representing a color. + +#### plot_border_color + +Defines the color of the border around the main plot area in a chart. +The default color is #d1d9d, light gray color. This parameter expects a +value of type character (hdtype Clr). + +#### plot_border_width + +Determines the width of the border around the main plot area in a chart. +The default width is 1 and expects a value of type numeric (hdtype Num). + +#### plot_margin_bottom + +Controls the margin at the bottom of the plot area. It affects the space +between the plot area and other elements of the chart or the edges of +the visualization. The default value is NULL and expects a value of type +numeric (hdtype Num). + +#### plot_margin_left + +Controls the margin on the left side of the plot area. It affects the +space between the plot area and other elements of the chart or the edges +of the visualization. The default value is NULL and expects a value of +type numeric (hdtype Num). + +#### plot_margin_right + +Controls the margin on the right side of the plot area. Adjusting this +margin can be useful to ensure that all elements of the chart are +visible and not cramped. The default value is NA, expects a value of +type numeric (hdtype Num). + +#### plot_margin_top + +Controls the margin at the top of the plot area. The default value is +10, providing a margin of 10 units. This parameter expects a value of +type numeric (hdtype Num). + +#### subtitle_align + +Determines the alignment of the subtitle in the visualization. The +default alignment is left and its type is character (hdtype Cat), +meaning it accepts values such as "left", "center", or "right". + +#### subtitle_color + +Defines the color of the subtitle text in the visualization. You can +specify the color using any valid format. The default color is #28333f +and its type is character (hdtype Clr). + +#### subtitle_size + +Specifies the font size, in points, of the subtitle text in the +visualization. The default size is 17 points and it expects a value of +type numeric (hdtype Num). + +#### subtitle_weight + +Specifies the font weight of the subtitle text in the visualization.The +default weight is 700, and its type is character (hdtype Cat). + +#### table_table_background+ + +Defines the background color for the entire table. The default color is #ffffff, which corresponds to white. You can change this value to +customize the background color of the table. This parameter expects a +color value (hdtype Clr). + +#### text_color + +Specifies the general text color in the visualization. The default color +is #28333f, which is a dark blue-gray. You can change this value to +customize the text color throughout the visualization. This parameter +expects a color value (hdtype Clr). + +#### text_size + +Specifies the general text size in the visualization. The default size +is 12, but you can adjust this value to make the text larger or smaller +throughout the visualization. This parameter expects a numeric value +(hdtype Num). + +#### text_wrap + +Determines the maximum number of characters that can appear in a single +line of text in the visualization. If a text string exceeds this limit, +it will wrap onto the next line. The default value is 12, meaning that +text will wrap after 12 characters. This parameter expects a numeric +value (hdtype Num). + +#### title_align + +Controls the alignment of the title within the visualization. By +default, the title is aligned to the left, but you can adjust it to be +centered or aligned to the right. it expects a value of type numeric +(hdtype Cat). + +#### title_axis_color + +Specifies the color of the text used for the axis titles in a chart. +This helps distinguish the axis titles from other text in the +visualization. The default value is NULL, indicating that the color is +not explicitly set. It expects a value of type character (hdtype Clr). + +#### title_axis_size + +Defines the font size for the axis titles in a graphic. The default size +is 13 points, and you can specify values from 1 to 20 points. Its type +is numeric (hdtype Num). + +#### title_color + +Specifies the color of the text used for the main title in a +visualization. The default color is #28333f and it expects a value of +type character(hdtype Clr). + +#### title_family + +Specifies the font family used for the main title in a visualization. +The default font family is IBM Plex Sans and it expects a value of type +character(hdtype Fnt). + +#### title_size + +Determines the font size of the visualization's title. The default size +is 21 points but you can adjust this value from 1 to 20 points. It +expects a value of type numeric (hdtype Num). + +#### title_weight + +Specifies the font weight of the visualization's title. The default +weight is 700 (bold style), but you can choose between several options +such as thin, light, regular, medium, bold, and black. It expects a +value of type character (hdtype Cat). + +#### tooltip_background + +Defines the background color of tooltips that provide additional information when hovering over elements in the visualization. The default color is #ffffff (white), but you can customize this color to fit the style of the visualization. This parameter expects a color value (hdtype Clr). + +#### tooltip_text_family + +Defines the font family used for the text inside tooltips. The default is NULL, which means the default font will be used. You can specify a font family from the available fonts list to customize the appearance of the tooltips. This parameter expects a character value (hdtype Fnt). + +#### tooltip_text_size + +Sets the font size for the text inside tooltips. The default size is 14 points, but you can specify a size between 1 and 20 points to adjust the text size in the tooltips. This parameter expects a numeric value representing the font size (hdtype Num). + +#### x_max + +Sets the maximum value for the X-axis in a chart. It determines the upper limit of the X-axis, controlling the range of data displayed along this axis. The default value is NULL and expects a numeric value (hdtype Num). + +#### x_min + +Sets the minimum value for the X-axis in a chart. It determines the lower limit of the X-axis, controlling the range of data displayed along this axis. The default value is NULL and expects a numeric value (hdtype Num). + +#### y_axis_align + +Specifies the alignment of the Y-axis labels in a chart. It can be set to "left", "right", or "center" relative to the axis. The default value is NULL, which means that the alignment is determined automatically and expects a character values (hdtype Cat). + +#### y_max + +Set the maximum value represented on the Y-axis of a chart. This parameter allows you to focus the visualization on a specific range of interest by defining the upper limit of the Y-axis. The default value is NULL and it expects a numerical value (hdtype Num). + +#### y_min + +Sets the minimum value for the Y-axis in a chart. It determines the lower limit of the Y-axis, controlling the range of data displayed along this axis. The default value is NULL and it expects a numeric value (hdtype Num). diff --git a/vignettes/titles_options.Rmd b/vignettes/titles_options.Rmd new file mode 100644 index 0000000..44b9cff --- /dev/null +++ b/vignettes/titles_options.Rmd @@ -0,0 +1,140 @@ +--- +title: "titles options" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{titles options} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + + +This page aims to explain the options available in the titles category. It will discuss the purpose of each argument, the possible values it can take, and the expected outcome of each argument. + +#### caption + +Provide a descriptive or explanatory text that accompanies a visualization, providing additional context such as the data source. It expects a value of type character (hdtype Txt). + +#### caption_align + +Controls the alignment of the credits in the visualization. The default alignment is "left" and it expects a value of type character (hdtype Cat). + +#### caption_color + +Controls the color of the text for the credits in the visualization. The default color is #28333f and it expects a value of type character (hdtype Clr). + +#### caption_link + +Specify a link associated with the credits of the graph. It accepts values of type character (hdtype Txt), where a valid URL can be provided as a string. The default value is NULL. + +#### caption_margin + +Specifies the margin around the credits of the visualization. The default value is 15 and its it expects a value of type numeric (hdtype Num). + +#### caption_size + +Specifies the font size, in points, of the text in the credits of the visualization. The default value is 12 and it expects a value of type numeric (hdtype Num). + +#### caption_weight + +Specifies the font weight used for the credits in a visualization. A higher weight corresponds to a bolder text. The default value is NULL and it expects a value of type character (hdtype Cat). + +#### subtitle + +Defines secondary text that offers additional information or context about the visualization, typically positioned below the main title and it expects a value of type character (hdtype Txt). + +#### subtitle_align + +Determines the alignment of the subtitle in the visualization. The default alignment is left and its type is character (hdtype Cat), meaning it accepts values such as "left", "center", or "right". + +#### subtitle_color + +Defines the color of the subtitle text in the visualization. You can specify the color using any valid format. The default color is #28333f and its type is character (hdtype Clr). + +#### subtitle_size + +Specifies the font size, in points, of the subtitle text in the visualization. The default size is 17 points and it expects a value of type numeric (hdtype Num). + +#### subtitle_weight + +Specifies the font weight of the subtitle text in the visualization.The default weight is 700, and its type is character (hdtype Cat). + +#### title + +Defines the main title of the visualization, it accepts characters values(hdtype Txt). + +#### title_align + +Controls the alignment of the title within the visualization. By default, the title is aligned to the left, but you can adjust it to be centered or aligned to the right. it expects a value of type numeric (hdtype Cat). + +#### title_axis_color + +Specifies the color of the text used for the axis titles in a chart. This helps distinguish the axis titles from other text in the visualization. The default value is NULL, indicating that the color is not explicitly set. It expects a value of type character (hdtype Clr). + +#### title_axis_size + +Defines the font size for the axis titles in a graphic. The default size is 13 points, and you can specify values from 1 to 20 points. Its type is numeric (hdtype Num). + +#### title_color + +Specifies the color of the text used for the main title in a visualization. The default color is #28333f and it expects a value of type character(hdtype Clr). + +#### title_family + +Specifies the font family used for the main title in a visualization. The default font family is IBM Plex Sans and it expects a value of type character(hdtype Fnt). + +#### title_legend + +Defines the title for the legend in the visualization. The legend helps viewers to identify the meaning of each color, shape, or symbol used in the chart. Its type is character (hdtype Txt). + +#### title_size + +Determines the font size of the visualization's title. The default size is 21 points but you can adjust this value from 1 to 20 points. It expects a value of type numeric (hdtype Num). + +#### title_weight + +Specifies the font weight of the visualization's title. The default weight is 700 (bold style), but you can choose between several options such as thin, light, regular, medium, bold, and black. It expects a value of type character (hdtype Cat).