diff --git a/pkgdown.yml b/pkgdown.yml
index a5dbe9d..5ac3418 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.1.11
 pkgdown: 2.1.0
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-08-23T21:31Z
+last_built: 2024-08-24T14:15Z
 urls:
   reference: https://nifu-no.github.io/saros.contents/reference
   article: https://nifu-no.github.io/saros.contents/articles
diff --git a/reference/ggsaver.html b/reference/ggsaver.html
index 7afcdbc..114868b 100644
--- a/reference/ggsaver.html
+++ b/reference/ggsaver.html
@@ -75,7 +75,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
 <span class="r-in"><span><span class="va">my_plot</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/ggplot.html" class="external-link">ggplot</a></span><span class="op">(</span>data<span class="op">=</span><span class="va">mtcars</span>, <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/aes.html" class="external-link">aes</a></span><span class="op">(</span>x<span class="op">=</span><span class="va">hp</span>, y<span class="op">=</span><span class="va">mpg</span><span class="op">)</span><span class="op">)</span> <span class="op">+</span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/geom_point.html" class="external-link">geom_point</a></span><span class="op">(</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="make_link.html">make_link</a></span><span class="op">(</span><span class="va">my_plot</span>, folder<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span>, file_suffix <span class="op">=</span> <span class="st">".png"</span>,</span></span>
 <span class="r-in"><span>          save_fn <span class="op">=</span> <span class="va">ggsaver</span>, width <span class="op">=</span> <span class="fl">16</span>, height <span class="op">=</span> <span class="fl">16</span>, units <span class="op">=</span> <span class="st">"cm"</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "[download figure data](/tmp/RtmpViJR12/e8e7d3fd7d6226a76d648c0afb9c9e3f.png)"</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "[download figure data](/tmp/RtmpPE2Usf/9c80c3411afb3306e71208c23c27e10c.png)"</span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
diff --git a/reference/make_link.html b/reference/make_link.html
index 22a202a..b3bb097 100644
--- a/reference/make_link.html
+++ b/reference/make_link.html
@@ -121,7 +121,7 @@ <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2
     <div class="section level2">
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
     <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">make_link</span><span class="op">(</span><span class="va">mtcars</span>, folder<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempdir</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "[download figure data](/tmp/RtmpViJR12/d0487363db4e6cc64fdb740cb6617fc0.csv)"</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "[download figure data](/tmp/RtmpPE2Usf/d0487363db4e6cc64fdb740cb6617fc0.csv)"</span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
diff --git a/search.json b/search.json
index f3d3e64..9598cb9 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":[]},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement stephus.daus@gmail.com. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://nifu-no.github.io/saros.contents/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Stephan Daus saros free, except Norway. Outside Norway, package can used accordance MIT license. However, persons affiliated Norwegian non-profit profit/commercial organizations must explicit written permission author use. Simply put, department/organization competes NIFU commissioned open research calls within Norway, probably going get permission unfortunately. Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://nifu-no.github.io/saros.contents/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Stephan Daus. Author, maintainer, copyright holder. Julia Silge. Contributor.           Author internal scale_x_reordered David Robinson. Contributor.           Author internal scale_x_reordered Nordic Institute Studies Innovation, Research Education (NIFU). Funder. Kristiania University College. Funder.","code":""},{"path":"https://nifu-no.github.io/saros.contents/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Stephan Daus (2024). saros: Semi-Automated Reporting Ordinary Surveys. Nordic institute studies innovation, research education (NIFU). https://nifu-.github.io/saros/.","code":"@Manual{,   title = {saros: Semi-Automated Reporting of Ordinary Surveys},   author = {{Stephan Daus}},   organization = {Nordic institute for the studies of innovation, research and education (NIFU)},   year = {2024},   url = {https://nifu-no.github.io/saros/}, }"},{"path":[]},{"path":"https://nifu-no.github.io/saros.contents/index.html","id":"sub-package","dir":"","previous_headings":"","what":"Sub-package","title":"Contents for the Semi-Automatic Reporting of Ordinary Surveys (Saros)","text":"saros.contents merely upstream sub-package used {saros}-package. Go common presentation packages, see documentation saros.contents-functions.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ex_survey.html","id":null,"dir":"Reference","previous_headings":"","what":"ex_survey: Mockup dataset of a survey. — ex_survey","title":"ex_survey: Mockup dataset of a survey. — ex_survey","text":"dataset containing fake respondents' answers survey questions. first two, x_sex x_human, intended independent variables, whereas remaining dependent. underscore _ variable names separates item groups (prefix) items (suffix) (.e. a_1-a_9 => + 1-9), whereas ' - ' separates labels. latter corresponds default SurveyXact.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ex_survey.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ex_survey: Mockup dataset of a survey. — ex_survey","text":"","code":"ex_survey"},{"path":"https://nifu-no.github.io/saros.contents/reference/ex_survey.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"ex_survey: Mockup dataset of a survey. — ex_survey","text":"data frame 100 rows 29 variables: x1_sex Gender x2_human respondent human? x3_nationality respondent born? a_1 consent following? - Agreement #1 a_2 consent following? - Agreement #2 a_3 consent following? - Agreement #3 a_4 consent following? - Agreement #4 a_5 consent following? - Agreement #5 a_6 consent following? - Agreement #6 a_7 consent following? - Agreement #7 a_8 consent following? - Agreement #8 a_9 consent following? - Agreement #9 b_1 much like living - Beijing b_2 much like living - Brussels b_3 much like living - Budapest c_1 many years experience - Company c_2 many years experience - Company B d_1 Rate degree confidence following - Driving d_2 Rate degree confidence following - Drinking d_3 Rate degree confidence following - Driving d_4 Rate degree confidence following - Dancing e_1 often following? - Eat e_2 often following? - Eavesdrop e_3 often following? - Exercise e_4 often following? - Encourage someone recently met struggles simple tasks achieve p_1 extent agree disagree following policies - Red Party p_2 extent agree disagree following policies - Green Party p_3 extent agree disagree following policies - Yellow Party p_4 extent agree disagree following policies - Blue Party f_uni following universities prefer study ? open_comments comments survey? resp_status Response status","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":null,"dir":"Reference","previous_headings":"","what":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"function estimates height figure horizontal bar chart based several parameters including number dependent independent variables, number categories, maximum characters labels, legend properties.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"","code":"fig_height_h_barchart(   n_y,   n_cats_y,   max_chars_y,   n_x = NULL,   n_cats_x = NULL,   max_chars_x = NULL,   freq = FALSE,   x_axis_label_width = 20,   strip_angle = 0,   main_font_size = 7,   legend_location = c(\"plot\", \"panel\"),   n_legend_lines = 2,   legend_key_chars_equivalence = 5,   max_chars_per_figure_width = 100,   multiplier_per_horizontal_line = NULL,   multiplier_per_vertical_letter = 1,   multiplier_per_facet = 1,   multiplier_per_legend_line = 1,   fixed_constant = 0,   figure_width_in_cm = 14,   margin_in_cm = 0,   max = 8,   min = 1 )"},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"n_y Integer. Number dependent variables. n_cats_y Integer. Number categories across dependent variables. max_chars_y Integer. Maximum number characters across dependent variables. n_x Integer. Number independent variables. n_cats_x Integer. Number categories across independent variables. max_chars_x Integer. Maximum number characters across independent variables. freq Logical. TRUE, frequency plot categories next . FALSE (default), proportion plot stacked categories. x_axis_label_width Numeric. Width allocated x-axis labels. strip_angle Integer. Angle strip text. main_font_size Numeric. Font size main text. legend_location Character. Location legend (\"panel\" \"plot\"). n_legend_lines Integer. Number lines legend. legend_key_chars_equivalence Integer. Approximate number characters legend key equals. max_chars_per_figure_width Integer. Maximum number characters per figure width. multiplier_per_horizontal_line Numeric. Multiplier per horizontal line. multiplier_per_vertical_letter Numeric. Multiplier per vertical letter. multiplier_per_facet Numeric. Multiplier per facet. multiplier_per_legend_line Numeric. Multiplier per legend line. fixed_constant Numeric. Fixed constant added height. figure_width_in_cm Numeric. Width figure centimeters. margin_in_cm Numeric. Margin centimeters. max Numeric. Maximum height. min Numeric. Minimum height.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"Numeric value representing estimated height figure.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"","code":"fig_height_h_barchart(n_y = 5,                       n_cats_y = 3,                       max_chars_y = 10,                       n_x = 2,                       n_cats_x = 4,                       max_chars_x = 12,                       freq = FALSE,                       x_axis_label_width = 20,                       strip_angle = 0,                       main_font_size = 8,                       legend_location = \"panel\",                       n_legend_lines = 2,                       legend_key_chars_equivalence = 5,                       max_chars_per_figure_width = 100,                       multiplier_per_horizontal_line = NULL,                       multiplier_per_vertical_letter = .15,                       multiplier_per_facet = .95,                       multiplier_per_legend_line = 1.5,                       fixed_constant = 0,                       figure_width_in_cm = 16,                       margin_in_cm = 0,                       max = 8,                       min = 1) #> [1] 5.1"},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":null,"dir":"Reference","previous_headings":"","what":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"Taking object makeme(), function estimates height figure horizontal bar chart.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"","code":"fig_height_h_barchart2(   ggobj,   freq = FALSE,   x_axis_label_width = 20,   strip_angle = 0,   main_font_size = 8,   legend_location = c(\"panel\", \"plot\"),   n_legend_lines = 2,   legend_key_chars_equivalence = 5,   max_chars_per_figure_width = 100,   multiplier_per_horizontal_line = NULL,   multiplier_per_vertical_letter = 0.01,   multiplier_per_facet = 0.95,   multiplier_per_legend_line = 1.5,   fixed_constant = 0,   figure_width_in_cm = 16,   margin_in_cm = 0,   max = 8,   min = 1 )"},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"ggobj ggplot2-object freq Logical. TRUE, frequency plot categories next . FALSE (default), proportion plot stacked categories. x_axis_label_width Numeric. Width allocated x-axis labels. strip_angle Integer. Angle strip text. main_font_size Numeric. Font size main text. legend_location Character. Location legend (\"panel\" \"plot\"). n_legend_lines Integer. Number lines legend. legend_key_chars_equivalence Integer. Approximate number characters legend key equals. max_chars_per_figure_width Integer. Maximum number characters per figure width. multiplier_per_horizontal_line Numeric. Multiplier per horizontal line. multiplier_per_vertical_letter Numeric. Multiplier per vertical letter. multiplier_per_facet Numeric. Multiplier per facet. multiplier_per_legend_line Numeric. Multiplier per legend line. fixed_constant Numeric. Fixed constant added height. figure_width_in_cm Numeric. Width figure centimeters. margin_in_cm Numeric. Margin centimeters. max Numeric. Maximum height. min Numeric. Minimum height.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"Numeric value representing estimated height figure.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"","code":"fig_height_h_barchart2(makeme(data=ex_survey, dep=b_1:b_3, indep=x1_sex)) #> [1] 2.58"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_palette.html","id":null,"dir":"Reference","previous_headings":"","what":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","text":"Possibly using colour_palette_nominal available. sufficient, uses set palette RColorBrewer.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_palette.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","text":"","code":"get_colour_palette(   data,   col_pos,   colour_palette_nominal = NULL,   colour_palette_ordinal = NULL,   colour_na = NULL,   categories_treated_as_na = NULL,   call = rlang::caller_env() )"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_palette.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","text":"data data.frame/tibble srvyr-object (experimental) data.frame // required data used plotting. col_pos Character vector column names colours found. colour_palette_nominal, colour_palette_ordinal User specified colour set vector<character> // default: NULL (optional) User-supplied default palette, excluding colour_na. colour_na Colour NA category scalar<character> // default: NULL (optional) Colour single string NA values, showNA \"ifany\" \"always\". categories_treated_as_na NA categories vector<character> // default: NULL (optional) Categories treated NA. call Internal call obj:<call> // Default: rlang::caller_env() (optional) absolute relative folderpaths required, strings.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_palette.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","text":"colour set character vector, NA colour_na, rest taken colour_palette_nominal available.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_set.html","id":null,"dir":"Reference","previous_headings":"","what":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","text":"Possibly using colour_palette_nominal available. sufficient, uses set palette RColorBrewer.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_set.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","text":"","code":"get_colour_set(   x,   common_data_type = \"factor\",   colour_palette_nominal = NULL,   colour_palette_ordinal = NULL,   colour_na = NULL,   colour_2nd_binary_cat = NULL,   ordinal = FALSE,   categories_treated_as_na = NULL,   call = rlang::caller_env() )"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_set.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","text":"x Vector colours found. common_data_type factor ordered data type scalar<character> // default: factor (optional) Currently supports factor ordered. colour_palette_nominal, colour_palette_ordinal User specified colour set vector<character> // default: NULL (optional) User-supplied default palette, excluding colour_na. colour_na Colour NA category scalar<character> // default: NULL (optional) Colour single string NA values, showNA \"ifany\" \"always\". colour_2nd_binary_cat Colour second binary category scalar<character> // default: \"#ffffff\" (optional) Colour second category binary variables. Often useful hide . ordinal scalar<logical> // default: FALSE (optional) palette ordinal? categories_treated_as_na NA categories vector<character> // default: NULL (optional) Categories treated NA. call Internal call obj:<call> // Default: rlang::caller_env() (optional) absolute relative folderpaths required, strings.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_set.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","text":"colour set character vector, NA colour_na, rest taken colour_palette_nominal available.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_data_label_opts.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Valid Data Labels for Figures and Tables — get_data_label_opts","title":"Get Valid Data Labels for Figures and Tables — get_data_label_opts","text":"Get Valid Data Labels Figures Tables","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_data_label_opts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Valid Data Labels for Figures and Tables — get_data_label_opts","text":"","code":"get_data_label_opts()"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_data_label_opts.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Valid Data Labels for Figures and Tables — get_data_label_opts","text":"Character vector","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":null,"dir":"Reference","previous_headings":"","what":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"makeme()-function take argument type one several strings indicate content type output type. function collects registered alternatives. Extensions possible, see . Built-types: Whereas names types can arbitrary, pattern pursued built-types. Prefix indicates dependent data type intended \"cat\" Categorical (ordinal nominal) data. \"chr\" Open ended responses character data. \"int\" Integer numeric data. Suffix indicates output \"html\" Interactive html, usually want Quarto, Quarto can usually convert formats needed \"docx\" However, Quarto's Pandoc's docx-support currently still limited, instance vector graphics converted raster graphics docx output. Hence, saros.contents offers types outputs MS Chart vector graphics. Note experimental actively developed. \"pdf\" basically just shortcut \"html\" interactive=FALSE","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"","code":"get_makeme_types()"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"Character vector","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"further-details-about-some-of-the-built-in-types-","dir":"Reference","previous_headings":"","what":"Further details about some of the built-in types:","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"\"cat_plot_\" Likert style plot groups categorical variables sharing categories. \"cat_table_\" Likert style table. \"chr_table_\" single-column table listing unique open ended responses. \"sigtest_table_\" See sigtest_table_\\*: Make Table Combinations Univariate/Bivariate Significance Tests Based Variable Types Although hundreds significance tests associations two variables, depending upon distributions, variables types assumptions, fall smaller set popular tests. function runs combinations dependent independent variables data, suitable test (possible) combination. Also supports univariate tests, assumptions mean zero continuous variables equal proportions binary/categorical. function allow adjustments - use original underlying functions (chisq.test, t.test, etc.)","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"expanding-with-custom-types","dir":"Reference","previous_headings":"","what":"Expanding with custom types","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"makeme() calls generic make_content(), uses S3-method system dispatch relevant method (.e., paste0(\"make_content.\", type)). makeme forwards arguments make_content, following exceptions: dep indep converted dplyr::dplyr_tidy_select()-syntax simple character vectors, simplifying building functions. data_summary attached, contains many useful pieces info many (categorical) displays.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"","code":"get_makeme_types() #> [1] \"cat_freq_plot_docx\" \"cat_plot_html\"      \"cat_prop_plot_docx\" #> [4] \"cat_table_html\"     \"chr_table_html\"     \"sigtest_table_html\""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_raw_labels.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function to extract raw variable labels from the data — get_raw_labels","title":"Helper function to extract raw variable labels from the data — get_raw_labels","text":"Helper function extract raw variable labels data","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_raw_labels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function to extract raw variable labels from the data — get_raw_labels","text":"","code":"get_raw_labels(data, col_pos = NULL, return_as_list = FALSE)"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_raw_labels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function to extract raw variable labels from the data — get_raw_labels","text":"data Dataset col_pos Optional, character vector column names integer vector positions return_as_list Flag, whether return list character vector","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_raw_labels.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function to extract raw variable labels from the data — get_raw_labels","text":"List character vector","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":null,"dir":"Reference","previous_headings":"","what":"Wrapper Function for ggplot2::ggsave() — ggsaver","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"exists make easy use make_link()","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"","code":"ggsaver(plot, filename, ...)"},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"plot Plot filename Note ... Arguments forwarded ggplot2::ggsave()","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"return value, called side effects","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"","code":"library(ggplot2) my_plot <- ggplot(data=mtcars, aes(x=hp, y=mpg)) + geom_point() make_link(my_plot, folder=tempdir(), file_suffix = \".png\",           save_fn = ggsaver, width = 16, height = 16, units = \"cm\") #> [1] \"[download figure data](/tmp/RtmpViJR12/e8e7d3fd7d6226a76d648c0afb9c9e3f.png)\""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Global Options for saros-functions — global_settings_get","title":"Get Global Options for saros-functions — global_settings_get","text":"Get Global Options saros-functions","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Global Options for saros-functions — global_settings_get","text":"","code":"global_settings_get(fn_name = \"makeme\")"},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Global Options for saros-functions — global_settings_get","text":"fn_name String, one \"make_link\", \"fig_height_h_barchart\" \"makeme\".","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Global Options for saros-functions — global_settings_get","text":"List options R","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Global Options for saros-functions — global_settings_get","text":"","code":"global_settings_get() #> $type #> [1] \"cat_plot_html\" #>  #> $require_common_categories #> [1] TRUE #>  #> $crowd #> [1] \"all\" #>  #> $mesos_var #> NULL #>  #> $mesos_group #> NULL #>  #> $simplify_output #> [1] TRUE #>  #> $hide_for_crowd_if_all_na #> [1] TRUE #>  #> $hide_for_crowd_if_valid_n_below #> [1] 0 #>  #> $hide_for_crowd_if_category_k_below #> [1] 2 #>  #> $hide_for_crowd_if_category_n_below #> [1] 0 #>  #> $hide_for_crowd_if_cell_n_below #> [1] 0 #>  #> $hide_for_all_crowds_if_hidden_for_crowd #> NULL #>  #> $hide_indep_cat_for_all_crowds_if_hidden_for_crowd #> [1] FALSE #>  #> $add_n_to_label #> [1] FALSE #>  #> $add_n_to_category #> [1] FALSE #>  #> $totals #> [1] FALSE #>  #> $categories_treated_as_na #> NULL #>  #> $label_separator #> [1] \" - \" #>  #> $showNA #> [1] \"ifany\" #>  #> $data_label #> [1] \"percentage_bare\" #>  #> $html_interactive #> [1] TRUE #>  #> $hide_axis_text_if_single_variable #> [1] TRUE #>  #> $hide_label_if_prop_below #> [1] 0.01 #>  #> $inverse #> [1] FALSE #>  #> $vertical #> [1] FALSE #>  #> $digits #> [1] 0 #>  #> $data_label_decimal_symbol #> [1] \".\" #>  #> $x_axis_label_width #> [1] 25 #>  #> $strip_width #> [1] 25 #>  #> $sort_by #> [1] \".upper\" #>  #> $descend #> [1] TRUE #>  #> $variables_always_at_top #> NULL #>  #> $variables_always_at_bottom #> NULL #>  #> $table_wide #> [1] TRUE #>  #> $table_main_question_as_header #> [1] FALSE #>  #> $translations #> $translations$last_sep #> [1] \" and \" #>  #> $translations$table_heading_N #> [1] \"Total (N)\" #>  #> $translations$add_n_to_label_prefix #> [1] \" (N = \" #>  #> $translations$add_n_to_label_suffix #> [1] \")\" #>  #> $translations$add_n_to_category_prefix #> [1] \" (N = [\" #>  #> $translations$add_n_to_category_infix #> [1] \",\" #>  #> $translations$add_n_to_category_suffix #> [1] \"])\" #>  #> $translations$by_total #> [1] \"Everyone\" #>  #> $translations$sigtest_variable_header_1 #> [1] \"Var 1\" #>  #> $translations$sigtest_variable_header_2 #> [1] \"Var 2\" #>  #> $translations$crowd_all #> [1] \"All\" #>  #> $translations$crowd_target #> [1] \"Target\" #>  #> $translations$crowd_others #> [1] \"Others\" #>  #>  #> $plot_height #> [1] 15 #>  #> $colour_palette #> NULL #>  #> $colour_2nd_binary_cat #> [1] \"#ffffff\" #>  #> $colour_na #> [1] \"grey\" #>  #> $label_font_size #> [1] 6 #>  #> $main_font_size #> [1] 6 #>  #> $strip_font_size #> [1] 6 #>  #> $legend_font_size #> [1] 6 #>  #> $font_family #> [1] \"sans\" #>  #> $path #> NULL #>  #> $docx_template #> NULL #>"},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":null,"dir":"Reference","previous_headings":"","what":"Reset Global Options for saros-functions — global_settings_reset","title":"Reset Global Options for saros-functions — global_settings_reset","text":"Reset Global Options saros-functions","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reset Global Options for saros-functions — global_settings_reset","text":"","code":"global_settings_reset(fn_name = \"makeme\")"},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reset Global Options for saros-functions — global_settings_reset","text":"fn_name String, one \"make_link\", \"fig_height_h_barchart\" \"makeme\".","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reset Global Options for saros-functions — global_settings_reset","text":"Invisibly returned list old new values.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reset Global Options for saros-functions — global_settings_reset","text":"","code":"global_settings_reset() #> \"options('saros')$makeme_defaults\" has now been reset to factory defaults."},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Global Options for saros-functions — global_settings_set","title":"Get Global Options for saros-functions — global_settings_set","text":"Get Global Options saros-functions","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Global Options for saros-functions — global_settings_set","text":"","code":"global_settings_set(new, fn_name = \"makeme\", quiet = FALSE)"},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Global Options for saros-functions — global_settings_set","text":"new List arguments (see ?make_link(), ?makeme(), fig_height_h_barchart()) fn_name String, one \"make_link\", \"fig_height_h_barchart\" \"makeme\". quiet Flag. FALSE (default), informs set.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Global Options for saros-functions — global_settings_set","text":"Invisibly returned list old new values.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Global Options for saros-functions — global_settings_set","text":"","code":"global_settings_set(new=list(digits=2)) #> `options('saros')$makeme_defaults` has now been set."},{"path":"https://nifu-no.github.io/saros.contents/reference/hex_bw.html","id":null,"dir":"Reference","previous_headings":"","what":"Identify Suitable Font Given Background Hex Colour — hex_bw","title":"Identify Suitable Font Given Background Hex Colour — hex_bw","text":"Code taken XXX.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/hex_bw.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Identify Suitable Font Given Background Hex Colour — hex_bw","text":"","code":"hex_bw(hex_code)"},{"path":"https://nifu-no.github.io/saros.contents/reference/hex_bw.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Identify Suitable Font Given Background Hex Colour — hex_bw","text":"hex_code Colour hex-format.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/hex_bw.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Identify Suitable Font Given Background Hex Colour — hex_bw","text":"Colours hex-format, either black white.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_colour.html","id":null,"dir":"Reference","previous_headings":"","what":"Are All Colours in Vector Valid Colours — is_colour","title":"Are All Colours in Vector Valid Colours — is_colour","text":"title says. : (https://stackoverflow.com//13290832/3315962)","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_colour.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Are All Colours in Vector Valid Colours — is_colour","text":"","code":"is_colour(x)"},{"path":"https://nifu-no.github.io/saros.contents/reference/is_colour.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Are All Colours in Vector Valid Colours — is_colour","text":"x Character vector colours hex-format.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_colour.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Are All Colours in Vector Valid Colours — is_colour","text":"Logical, error.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_string.html","id":null,"dir":"Reference","previous_headings":"","what":"Is x A String? — is_string","title":"Is x A String? — is_string","text":"Returns TRUE object character length 1.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_string.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is x A String? — is_string","text":"","code":"is_string(x)"},{"path":"https://nifu-no.github.io/saros.contents/reference/is_string.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is x A String? — is_string","text":"x Object","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_string.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is x A String? — is_string","text":"Logical value.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_content.html","id":null,"dir":"Reference","previous_headings":"","what":"Method for Creating Saros Contents — make_content","title":"Method for Creating Saros Contents — make_content","text":"Takes arguments makeme, except dep indep make_content character vectors, ease user-customized function programming.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_content.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Method for Creating Saros Contents — make_content","text":"","code":"make_content(type, ...)"},{"path":"https://nifu-no.github.io/saros.contents/reference/make_content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Method for Creating Saros Contents — make_content","text":"type Method name scalar<character> class named . Optional string indicating specific method. Occasionally useful error messages, etc. ... Dots Arguments provided makeme","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_content.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Method for Creating Saros Contents — make_content","text":"returned object class depends type. type=\"*_table_html\" always returns tibble. type=\"*_plot_html\" always returns ggplot. type=\"*_docx\" always returns rdocx object path=NULL, side-effect writing docx file disk path set.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":null,"dir":"Reference","previous_headings":"","what":"Save data to a file and return a Markdown link — make_link","title":"Save data to a file and return a Markdown link — make_link","text":"file automatically named hash object, removing need come unique file names inside Quarto report. added benefit reducing storage needs objects needing linking identical, stored folder. also allows user download multiple files without worrying accidentally overwriting .","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save data to a file and return a Markdown link — make_link","text":"","code":"make_link(   data,   folder = NULL,   file_prefix = NULL,   file_suffix = \".csv\",   save_fn = utils::write.csv,   link_prefix = \"[download figure data](\",   link_suffix = \")\",   ... )"},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save data to a file and return a Markdown link — make_link","text":"data Data object <data.frame|tbl|obj> Data frame using tabular data save_fn, possibly R object, serializing save_fn provided (e.g. saveRDS()). folder store file scalar<character> // default: \".\" (optional) Defaults folder. file_prefix, file_suffix File prefix/suffix scalar<character> // default: \"\" \".csv\" (optional) file_suffix include dot extension. save_fn Saving function function // default: utils::write.csv Can saving/writing function. However, first argument must object saved, second must path. Hence, ggplot2::ggsave() must wrapped another function filename object swapped. See ggsaver() example wrapper function. link_prefix, link_suffix Link prefix/suffix scalar<character> // default: \"[download data](\" \")\" stuff returned. ... Dynamic dots <dynamic-dots> Arguments forwarded corresponding functions create elements.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Save data to a file and return a Markdown link — make_link","text":"String.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Save data to a file and return a Markdown link — make_link","text":"","code":"make_link(mtcars, folder=tempdir()) #> [1] \"[download figure data](/tmp/RtmpViJR12/d0487363db4e6cc64fdb740cb6617fc0.csv)\""},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":null,"dir":"Reference","previous_headings":"","what":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"function allows embedding interactive static plots based various types data using tidyselect syntax variable selection.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"","code":"makeme(   data,   dep = tidyselect::everything(),   indep = NULL,   type = c(\"cat_plot_html\", \"int_plot_html\", \"cat_table_html\", \"int_table_html\",     \"sigtest_table_html\", \"cat_prop_plot_docx\", \"cat_freq_plot_docx\", \"int_plot_docx\"),   ...,   require_common_categories = TRUE,   crowd = c(\"all\"),   mesos_var = NULL,   mesos_group = NULL,   simplify_output = TRUE,   hide_for_crowd_if_all_na = TRUE,   hide_for_crowd_if_valid_n_below = 0,   hide_for_crowd_if_category_k_below = 2,   hide_for_crowd_if_category_n_below = 0,   hide_for_crowd_if_cell_n_below = 0,   hide_for_all_crowds_if_hidden_for_crowd = NULL,   hide_indep_cat_for_all_crowds_if_hidden_for_crowd = FALSE,   add_n_to_label = FALSE,   add_n_to_category = FALSE,   totals = FALSE,   categories_treated_as_na = NULL,   label_separator = \" - \",   showNA = c(\"ifany\", \"always\", \"never\"),   data_label = c(\"percentage_bare\", \"percentage\", \"proportion\", \"count\"),   html_interactive = TRUE,   hide_axis_text_if_single_variable = TRUE,   hide_label_if_prop_below = 0.01,   inverse = FALSE,   vertical = FALSE,   digits = 0,   data_label_decimal_symbol = \".\",   x_axis_label_width = 25,   strip_width = 25,   sort_by = \".upper\",   descend = TRUE,   variables_always_at_top = NULL,   variables_always_at_bottom = NULL,   table_wide = TRUE,   table_main_question_as_header = FALSE,   translations = list(last_sep = \" and \", table_heading_N = \"Total (N)\",     add_n_to_label_prefix = \" (N = \", add_n_to_label_suffix = \")\",     add_n_to_category_prefix = \" (N = [\", add_n_to_category_infix = \",\",     add_n_to_category_suffix = \"])\", by_total = \"Everyone\", sigtest_variable_header_1 =     \"Var 1\", sigtest_variable_header_2 = \"Var 2\", crowd_all = \"All\", crowd_target =     \"Target\", crowd_others = \"Others\"),   plot_height = 15,   colour_palette = NULL,   colour_2nd_binary_cat = \"#ffffff\",   colour_na = \"grey\",   label_font_size = 6,   main_font_size = 6,   strip_font_size = 6,   legend_font_size = 6,   font_family = \"sans\",   path = NULL,   docx_template = NULL )"},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"data data.frame/tibble srvyr-object (experimental) data.frame // required data used plotting. dep, indep Variable selections <tidyselect> // Default: NULL, meaning everything dep, nothing indep. Columns data. dep compulsory. type Kind output scalar<character> // default: \"prop_plot\" (optional) list registered types session, use get_makeme_types(). ... Dynamic dots <dynamic-dots> Arguments forwarded corresponding functions create elements. require_common_categories Check common categories scalar<logical> // default: NULL (optional) Whether check items share common categories. crowd group(s) display results vector<character> // default: c(\"target\", \"others\", \"\") (optional) Choose whether produce results target (mesos) group, others, , combinations . mesos_var Variable data indicating groups tailor reports scalar<character> // default: NULL (optional) Column name data indicating groups mesos reports produced. mesos_group scalar<character> // default: NULL (optional) String, target group. simplify_output scalar<logical> // default: TRUE TRUE, list output single output element return element , whereas list multiple elements return list. hide_for_crowd_if_all_na Hide variable output containing NA scalar<boolean> // default: TRUE Whether remove variables (particular useful mesos) values NA hide_for_crowd_if_valid_n_below Hide variable variable < n observations scalar<integer> // default: 0 Whether hide variable crowd variable contains fewer n observations (always ignoring NA). hide_for_crowd_if_category_k_below Hide variable < k categories scalar<integer> // default: 2 Whether hide variable crowd variable contains fewer k used categories (always ignoring NA). Defaults 2 unitary plot/table rarely informative. hide_for_crowd_if_category_n_below Hide variable category < n observations scalar<integer> // default: 0 Whether hide variable crowd variable contains category less n observations (ignoring NA) Cells 0 count considered usually problem anonymity. hide_for_crowd_if_cell_n_below Hide variable cell < n scalar<integer> // default: 0 Whether hide variable crowd combination dep-indep results cell less n observations (ignoring NA). Cells 0 count considered usually problem anonymity. hide_for_all_crowds_if_hidden_for_crowd Conditional hiding scalar<character> // default: NULL (optional) Select one crowd output groups. selected, hide variable across crowd-outputs reason displayed hide_for_all_if_hidden_for_crowd. instance, say: crowd = c(\"target\", \"others\"), hide_variable_if_all_na = TRUE, hide_for_all_if_hidden_for_crowd = \"target\" hide variables target others-outputs NA target-group. hide_indep_cat_for_all_crowds_if_hidden_for_crowd Conditionally hide independent categories scalar<logical> // default: FALSE hide_for_all_crowds_if_hidden_for_crowd specified, categories indep variable(s) hidden crowd exist crowds specified hide_for_all_crowds_if_hidden_for_crowd? useful e.g. indep academic disciplines, mesos_var institutions, specific institution interested seeing academic disciplines offer . add_n_to_label Add N= variable label scalar<logical> // default: FALSE (optional) plots tables useful attach \"N=\" end label. Whether N N_valid depends showNA-setting. See also translations$add_n_to_label_prefix translations$add_n_to_label_suffix. add_n_to_category Add N= category scalar<logical> // default: FALSE (optional) plots tables useful attach \"N=\" end category. likely produce range across variables, hence infix (comma) minimum maximum can specified. Whether N N_valid depends showNA-setting. See also translations$add_n_to_category_prefix, translations$add_n_to_category_infix, translations$add_n_to_category_suffix. totals Include totals scalar<logical> // default: FALSE (optional) Whether include totals output. categories_treated_as_na NA categories vector<character> // default: NULL (optional) Categories treated NA. label_separator separate main question sub-question scalar<character> // default: NULL (optional) Separator main question sub-question. showNA Show NA categories vector<character> // default: c(\"ifany\", \"always\", \"never\") (optional) Choose whether show NA categories results. data_label Data label scalar<character> // default: \"proportion\" (optional) One \"proportion\", \"percentage\", \"percentage_bare\", \"count\", \"mean\", \"median\". html_interactive Toggle interactive plot scalar<logical> // default: TRUE (optional) Whether plot interactive (ggiraph) static (ggplot2). hide_axis_text_if_single_variable Hide y-axis text just single variable scalar<boolean> // default: FALSE (optional) Whether hide text y-axis label just single variable. hide_label_if_prop_below Hide label threshold scalar<numeric> // default: NULL (optional) Whether hide label value. inverse Flag swap x-axis faceting scalar<logical> // default: FALSE (optional) TRUE, swaps x-axis faceting. vertical Display plot vertically scalar<logical> // default: FALSE (optional) TRUE, display plot vertically. digits Decimal places scalar<integer> // default: 0L (optional) Number decimal places. data_label_decimal_symbol Decimal symbol scalar<character> // default: \".\" (optional) Decimal marker, might prefer comma ',' something else entirely. x_axis_label_width, strip_width Label width x-axis strip texts plots scalar<integer> // default: 20 (optional) Width labels used categorical column names x-axis texts strip texts. sort_by sort output vector<character> // default: NULL (optional) Sort output (collapse requested). using indep-argument, sorting differs ordered factors unordered factors: Ordering ordered factors always respected output. Unordered factors reordered sort_by. Currently, works best single dep. \".top\" proportion highest category available variable. \".upper\" sum proportions categories middle category. \".mid_upper\" sum proportions categories including middle category. \".mid_lower\" sum proportions categories including middle category. \".lower\" sum proportions categories middle category. \".bottom\" proportions lowest category available variable. \".variable_label\" Sort variable labels. \".id\" Sort variable names. \".by_group\" groups argument. character() Character vector category labels sum together. descend Sorting order scalar<logical> // default: FALSE (optional) Reverse sorting sort_by figures tables. See arrange_section_by sorting report sections. variables_always_at_top, variables_always_at_bottom Top/bottom variables vector<character> // default: NULL (optional) Column names data always placed top bottom figures/tables. table_wide Pivot table wider scalar<logical> // default: FALSE (optional) Whether pivot table wider. table_main_question_as_header Table main question header scalar<logical> // default: FALSE (optional) Whether include main question header table. translations Localize output list<character> list translations name code value translation. See examples. plot_height DOCX-setting scalar<numeric> // default: 12 (optional) DOCX plots need height, currently set easily Quarto chunk option. colour_palette Colour palette vector<character> // default: NULL (optional) Must contain least number unique values (including missing) data set. colour_2nd_binary_cat Colour second binary category scalar<character> // default: \"#ffffff\" (optional) Colour second category binary variables. Often useful hide . colour_na Colour NA category scalar<character> // default: NULL (optional) Colour single string NA values, showNA \"ifany\" \"always\". main_font_size, label_font_size, strip_font_size, legend_font_size Font sizes scalar<integer> // default: 6 (optional) DOCX-OUTPUT. output adjusted using e.g. ggplot2::theme() set global theme (ggplot2::theme_set()). Font sizes general text (6), data label text (3), strip text (6) legend text (6). font_family Font family scalar<character> // default: \"sans\" (optional) Word font family. See officer::fp_text. path Output path DOCX scalar<character> // default: NULL (optional) Path save docx-output. docx_template Filename rdocx object scalar<character>|<rdocx>-object // default: NULL (optional) Can either valid character path reference Word file, existing rdocx-object memory.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"ggplot-object, optionally extended ggplot object ggiraph features.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"","code":"makeme(data = ex_survey,        dep = b_1:b_3)  makeme(data = ex_survey,        dep = b_1, indep = x1_sex)  makeme(data = ex_survey,        dep = b_1:b_3, indep = c(x1_sex, x2_human),        type = \"sigtest_table_html\") #>   Var 1    Var 2                         .bi_test  .p_value n_valid_Males #> 1   b_1   x1_sex Chi-squared Goodness-of-Fit Test 0.7280089           151 #> 2   b_1 x2_human Chi-squared Goodness-of-Fit Test 0.5363252            NA #> 3   b_2   x1_sex Chi-squared Goodness-of-Fit Test 0.4474979           151 #> 4   b_2 x2_human Chi-squared Goodness-of-Fit Test 0.9552449            NA #> 5   b_3   x1_sex Chi-squared Goodness-of-Fit Test 0.8496092           151 #> 6   b_3 x2_human Chi-squared Goodness-of-Fit Test 0.2604879            NA #>   n_valid_Females n_Males n_Females n_valid_Definitely humanoid n_valid_Robot? #> 1             149     151       149                          NA             NA #> 2              NA      NA        NA                         144            156 #> 3             149     151       149                          NA             NA #> 4              NA      NA        NA                         144            156 #> 5             149     151       149                          NA             NA #> 6              NA      NA        NA                         144            156 #>   n_Definitely humanoid n_Robot? #> 1                    NA       NA #> 2                   144      156 #> 3                    NA       NA #> 4                   144      156 #> 5                    NA       NA #> 6                   144      156 makeme(data = ex_survey,        dep = b_1, indep = x1_sex,        type = \"cat_prop_plot_docx\") #> rdocx document with 2 element(s) #>  #> * styles: #>                 Normal              heading 1              heading 2  #>            \"paragraph\"            \"paragraph\"            \"paragraph\"  #>              heading 3 Default Paragraph Font           Normal Table  #>            \"paragraph\"            \"character\"                \"table\"  #>                No List                 strong               centered  #>            \"numbering\"            \"character\"            \"paragraph\"  #>         table_template    Light List Accent 2            Titre 1 Car  #>                \"table\"                \"table\"            \"character\"  #>            Titre 2 Car            Titre 3 Car          Image Caption  #>            \"character\"            \"character\"            \"paragraph\"  #>          Table Caption     Table Professional                  toc 1  #>            \"paragraph\"                \"table\"            \"paragraph\"  #>                  toc 2           Balloon Text    Texte de bulles Car  #>            \"paragraph\"            \"paragraph\"            \"character\"  #>           reference_id          graphic title            table title  #>            \"character\"            \"paragraph\"            \"paragraph\"  #>  #> * Content at cursor location: #>   level num_id text style_name content_type #> 1    NA     NA          Normal    paragraph makeme(data = ex_survey,        dep = p_1:p_4, indep = x2_human,        type = \"cat_table_html\") #> # A tibble: 8 × 8 #>   .variable_label `Is respondent human?` `Strongly disagree (%)` #>   <ord>           <fct>                  <chr>                   #> 1 Yellow Party    Robot?                 16.03                   #> 2 Yellow Party    Definitely humanoid    20.83                   #> 3 Blue Party      Robot?                 26.28                   #> 4 Blue Party      Definitely humanoid    19.44                   #> 5 Green Party     Robot?                 25.00                   #> 6 Green Party     Definitely humanoid    13.89                   #> 7 Red Party       Robot?                 19.23                   #> 8 Red Party       Definitely humanoid    16.67                   #> # ℹ 5 more variables: `Somewhat disagree (%)` <chr>, #> #   `Somewhat agree (%)` <chr>, `Strongly agree (%)` <chr>, `NA (%)` <chr>, #> #   `Total (N)` <int> makeme(data = ex_survey,        dep = b_1:b_3,        crowd = c(\"target\", \"others\", \"all\"),        mesos_var = \"f_uni\",        mesos_group = \"Uni of A\") #> $Target  #>  #> $Others  #>  #> $All  #>"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":null,"dir":"Reference","previous_headings":"","what":"Provides a range (or single value) for N in data, given dep and indep — n_range","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"Provides range (single value) N data, given dep indep","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"","code":"n_range(   data,   dep,   indep = NULL,   mesos_var = NULL,   mesos_group = NULL,   glue_template_1 = \"{n}\",   glue_template_2 = \"[{n[1]}-{n[2]}]\" )"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"data Dataset dep, indep Tidyselect syntax mesos_var Optional, NULL string specifying name variable used split dataset. mesos_group Optional, NULL string specifying value mesos_var indicating target group. glue_template_1, glue_template_2 String, case single value (1) range minimum-maximum values (2).","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"String.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"","code":"n_range(data=ex_survey, dep=b_1:b_3, indep=x1_sex) #> 300"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":null,"dir":"Reference","previous_headings":"","what":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"Provides range (single value) N ggplot2-object makeme()","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"","code":"n_range2(ggobj, glue_template_1 = \"{n}\", glue_template_2 = \"[{n[1]}-{n[2]}]\")"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"ggobj ggplot2-object. glue_template_1, glue_template_2 String, case single value (1) range minimum-maximum values (2).","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"String.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"","code":"n_range2(makeme(data = ex_survey, dep = b_1:b_3)) #> 300"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng.html","id":null,"dir":"Reference","previous_headings":"","what":"Obtain range of N for a given data set and other settings. — n_rng","title":"Obtain range of N for a given data set and other settings. — n_rng","text":"Obtain range N given data set settings.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Obtain range of N for a given data set and other settings. — n_rng","text":"","code":"n_rng(   data,   dep,   indep = NULL,   crowd = \"all\",   mesos_var = NULL,   mesos_group = NULL,   glue_template_1 = \"{n}\",   glue_template_2 = \"[{n[1]}-{n[2]}]\" )"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Obtain range of N for a given data set and other settings. — n_rng","text":"data Dataset dep, indep Character vector, names ()dependent variables crowd String, one \"\", \"target\" \"others\". mesos_var Optional, NULL string specifying name variable used split dataset. mesos_group Optional, NULL string specifying value mesos_var indicating target group. glue_template_1, glue_template_2 String, case single value (1) range minimum-maximum values (2).","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Obtain range of N for a given data set and other settings. — n_rng","text":"Always string.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng2.html","id":null,"dir":"Reference","previous_headings":"","what":"Obtain range of N for a given ggobj. — n_rng2","title":"Obtain range of N for a given ggobj. — n_rng2","text":"Obtain range N given ggobj.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Obtain range of N for a given ggobj. — n_rng2","text":"","code":"n_rng2(ggobj, glue_template_1 = \"{n}\", glue_template_2 = \"[{n[1]}-{n[2]}]\")"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Obtain range of N for a given ggobj. — n_rng2","text":"ggobj ggplot2-object. glue_template_1, glue_template_2 String, case single value (1) range minimum-maximum values (2).","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Obtain range of N for a given ggobj. — n_rng2","text":"Always string.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":null,"dir":"Reference","previous_headings":"","what":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"Permission hereby granted, free charge, person obtaining copy software associated documentation files (\"Software\"), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions:","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"","code":"reorder_within(x, by, within, fun = mean, sep = \"___\", ...)"},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"\"Original: Ordering categories within ggplot2 Facets\" Tyler Rinker: https://trinkerrstuff.wordpress.com/2016/12/23/ordering-categories-within-ggplot2-facets/ Based https://opensource.org/licenses/MIT Copyright (c) 2017, Julia Silge David Robinson","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"x Vector Vector within Vector (factor) fun Function, defaults mean sep String, separator ... Dots","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED \"\", WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/subset_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","title":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","text":"Useful identifying categories collected.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/subset_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","text":"","code":"subset_vector(   vec,   set = c(\".top\", \".upper\", \".mid_upper\", \".lower\", \".mid_lower\", \".bottom\", \".spread\"),   spread_n = NULL,   sort = FALSE )"},{"path":"https://nifu-no.github.io/saros.contents/reference/subset_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","text":"vec vector type. set character string, one c(\".top\", \".upper\", \".mid_upper\", \".lower\", \".mid_lower\", \".bottom\") spread_n number values extract set \"spread\". sort Whether sort output, defaults FALSE.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/subset_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","text":"Selected set vector.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/summarize_cat_cat_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","title":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","text":"Summarize survey dataset use tables graphs","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/summarize_cat_cat_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","text":"","code":"summarize_cat_cat_data(   data,   dep = colnames(data),   indep = NULL,   ...,   showNA = c(\"ifany\", \"always\", \"never\"),   totals = FALSE,   sort_by = \".upper\",   data_label = c(\"percentage_bare\", \"percentage\", \"proportion\", \"count\"),   digits = 0,   add_n_to_label = FALSE,   add_n_to_category = FALSE,   hide_label_if_prop_below = 0.01,   data_label_decimal_symbol = \".\",   categories_treated_as_na = NULL,   label_separator = NULL,   descend = FALSE,   variables_always_at_bottom = NULL,   variables_always_at_top = NULL,   translations = list(),   call = rlang::caller_env() )"},{"path":"https://nifu-no.github.io/saros.contents/reference/summarize_cat_cat_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","text":"data data.frame/tibble srvyr-object (experimental) data.frame // required data used plotting. dep, indep Variable selections <tidyselect> // Default: NULL, meaning everything dep, nothing indep. Columns data. dep compulsory. ... Dynamic dots <dynamic-dots> Arguments forwarded corresponding functions create elements. showNA Show NA categories vector<character> // default: c(\"ifany\", \"always\", \"never\") (optional) Choose whether show NA categories results. totals Include totals scalar<logical> // default: FALSE (optional) Whether include totals output. sort_by sort output vector<character> // default: NULL (optional) Sort output (collapse requested). using indep-argument, sorting differs ordered factors unordered factors: Ordering ordered factors always respected output. Unordered factors reordered sort_by. Currently, works best single dep. \".top\" proportion highest category available variable. \".upper\" sum proportions categories middle category. \".mid_upper\" sum proportions categories including middle category. \".mid_lower\" sum proportions categories including middle category. \".lower\" sum proportions categories middle category. \".bottom\" proportions lowest category available variable. \".variable_label\" Sort variable labels. \".id\" Sort variable names. \".by_group\" groups argument. character() Character vector category labels sum together. data_label Data label scalar<character> // default: \"proportion\" (optional) One \"proportion\", \"percentage\", \"percentage_bare\", \"count\", \"mean\", \"median\". digits Decimal places scalar<integer> // default: 0L (optional) Number decimal places. add_n_to_label Add N= variable label scalar<logical> // default: FALSE (optional) plots tables useful attach \"N=\" end label. Whether N N_valid depends showNA-setting. See also translations$add_n_to_label_prefix translations$add_n_to_label_suffix. add_n_to_category Add N= category scalar<logical> // default: FALSE (optional) plots tables useful attach \"N=\" end category. likely produce range across variables, hence infix (comma) minimum maximum can specified. Whether N N_valid depends showNA-setting. See also translations$add_n_to_category_prefix, translations$add_n_to_category_infix, translations$add_n_to_category_suffix. hide_label_if_prop_below Hide label threshold scalar<numeric> // default: NULL (optional) Whether hide label value. data_label_decimal_symbol Decimal symbol scalar<character> // default: \".\" (optional) Decimal marker, might prefer comma ',' something else entirely. categories_treated_as_na NA categories vector<character> // default: NULL (optional) Categories treated NA. label_separator separate main question sub-question scalar<character> // default: NULL (optional) Separator main question sub-question. descend Sorting order scalar<logical> // default: FALSE (optional) Reverse sorting sort_by figures tables. See arrange_section_by sorting report sections. variables_always_at_top, variables_always_at_bottom Top/bottom variables vector<character> // default: NULL (optional) Column names data always placed top bottom figures/tables. translations Localize output list<character> list translations name code value translation. See examples. call Internal call obj:<call> // Default: rlang::caller_env() (optional) absolute relative folderpaths required, strings.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/summarize_cat_cat_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","text":"Dataset","code":""},{"path":"https://nifu-no.github.io/saros.contents/news/index.html","id":"saroscontents-010","dir":"Changelog","previous_headings":"","what":"saros.contents 0.1.0","title":"saros.contents 0.1.0","text":"Initial CRAN submission.","code":""}]
+[{"path":[]},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement stephus.daus@gmail.com. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://nifu-no.github.io/saros.contents/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://nifu-no.github.io/saros.contents/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Stephan Daus saros free, except Norway. Outside Norway, package can used accordance MIT license. However, persons affiliated Norwegian non-profit profit/commercial organizations must explicit written permission author use. Simply put, department/organization competes NIFU commissioned open research calls within Norway, probably going get permission unfortunately. Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://nifu-no.github.io/saros.contents/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Stephan Daus. Author, maintainer, copyright holder. Julia Silge. Contributor.           Author internal scale_x_reordered David Robinson. Contributor.           Author internal scale_x_reordered Nordic Institute Studies Innovation, Research Education (NIFU). Funder. Kristiania University College. Funder.","code":""},{"path":"https://nifu-no.github.io/saros.contents/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Stephan Daus (2024). saros: Semi-Automated Reporting Ordinary Surveys. Nordic institute studies innovation, research education (NIFU). https://nifu-.github.io/saros/.","code":"@Manual{,   title = {saros: Semi-Automated Reporting of Ordinary Surveys},   author = {{Stephan Daus}},   organization = {Nordic institute for the studies of innovation, research and education (NIFU)},   year = {2024},   url = {https://nifu-no.github.io/saros/}, }"},{"path":[]},{"path":"https://nifu-no.github.io/saros.contents/index.html","id":"sub-package","dir":"","previous_headings":"","what":"Sub-package","title":"Contents for the Semi-Automatic Reporting of Ordinary Surveys (Saros)","text":"saros.contents merely upstream sub-package used {saros}-package. Go common presentation packages, see documentation saros.contents-functions.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ex_survey.html","id":null,"dir":"Reference","previous_headings":"","what":"ex_survey: Mockup dataset of a survey. — ex_survey","title":"ex_survey: Mockup dataset of a survey. — ex_survey","text":"dataset containing fake respondents' answers survey questions. first two, x_sex x_human, intended independent variables, whereas remaining dependent. underscore _ variable names separates item groups (prefix) items (suffix) (.e. a_1-a_9 => + 1-9), whereas ' - ' separates labels. latter corresponds default SurveyXact.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ex_survey.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ex_survey: Mockup dataset of a survey. — ex_survey","text":"","code":"ex_survey"},{"path":"https://nifu-no.github.io/saros.contents/reference/ex_survey.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"ex_survey: Mockup dataset of a survey. — ex_survey","text":"data frame 100 rows 29 variables: x1_sex Gender x2_human respondent human? x3_nationality respondent born? a_1 consent following? - Agreement #1 a_2 consent following? - Agreement #2 a_3 consent following? - Agreement #3 a_4 consent following? - Agreement #4 a_5 consent following? - Agreement #5 a_6 consent following? - Agreement #6 a_7 consent following? - Agreement #7 a_8 consent following? - Agreement #8 a_9 consent following? - Agreement #9 b_1 much like living - Beijing b_2 much like living - Brussels b_3 much like living - Budapest c_1 many years experience - Company c_2 many years experience - Company B d_1 Rate degree confidence following - Driving d_2 Rate degree confidence following - Drinking d_3 Rate degree confidence following - Driving d_4 Rate degree confidence following - Dancing e_1 often following? - Eat e_2 often following? - Eavesdrop e_3 often following? - Exercise e_4 often following? - Encourage someone recently met struggles simple tasks achieve p_1 extent agree disagree following policies - Red Party p_2 extent agree disagree following policies - Green Party p_3 extent agree disagree following policies - Yellow Party p_4 extent agree disagree following policies - Blue Party f_uni following universities prefer study ? open_comments comments survey? resp_status Response status","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":null,"dir":"Reference","previous_headings":"","what":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"function estimates height figure horizontal bar chart based several parameters including number dependent independent variables, number categories, maximum characters labels, legend properties.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"","code":"fig_height_h_barchart(   n_y,   n_cats_y,   max_chars_y,   n_x = NULL,   n_cats_x = NULL,   max_chars_x = NULL,   freq = FALSE,   x_axis_label_width = 20,   strip_angle = 0,   main_font_size = 7,   legend_location = c(\"plot\", \"panel\"),   n_legend_lines = 2,   legend_key_chars_equivalence = 5,   max_chars_per_figure_width = 100,   multiplier_per_horizontal_line = NULL,   multiplier_per_vertical_letter = 1,   multiplier_per_facet = 1,   multiplier_per_legend_line = 1,   fixed_constant = 0,   figure_width_in_cm = 14,   margin_in_cm = 0,   max = 8,   min = 1 )"},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"n_y Integer. Number dependent variables. n_cats_y Integer. Number categories across dependent variables. max_chars_y Integer. Maximum number characters across dependent variables. n_x Integer. Number independent variables. n_cats_x Integer. Number categories across independent variables. max_chars_x Integer. Maximum number characters across independent variables. freq Logical. TRUE, frequency plot categories next . FALSE (default), proportion plot stacked categories. x_axis_label_width Numeric. Width allocated x-axis labels. strip_angle Integer. Angle strip text. main_font_size Numeric. Font size main text. legend_location Character. Location legend (\"panel\" \"plot\"). n_legend_lines Integer. Number lines legend. legend_key_chars_equivalence Integer. Approximate number characters legend key equals. max_chars_per_figure_width Integer. Maximum number characters per figure width. multiplier_per_horizontal_line Numeric. Multiplier per horizontal line. multiplier_per_vertical_letter Numeric. Multiplier per vertical letter. multiplier_per_facet Numeric. Multiplier per facet. multiplier_per_legend_line Numeric. Multiplier per legend line. fixed_constant Numeric. Fixed constant added height. figure_width_in_cm Numeric. Width figure centimeters. margin_in_cm Numeric. Margin centimeters. max Numeric. Maximum height. min Numeric. Minimum height.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"Numeric value representing estimated height figure.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart","text":"","code":"fig_height_h_barchart(n_y = 5,                       n_cats_y = 3,                       max_chars_y = 10,                       n_x = 2,                       n_cats_x = 4,                       max_chars_x = 12,                       freq = FALSE,                       x_axis_label_width = 20,                       strip_angle = 0,                       main_font_size = 8,                       legend_location = \"panel\",                       n_legend_lines = 2,                       legend_key_chars_equivalence = 5,                       max_chars_per_figure_width = 100,                       multiplier_per_horizontal_line = NULL,                       multiplier_per_vertical_letter = .15,                       multiplier_per_facet = .95,                       multiplier_per_legend_line = 1.5,                       fixed_constant = 0,                       figure_width_in_cm = 16,                       margin_in_cm = 0,                       max = 8,                       min = 1) #> [1] 5.1"},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":null,"dir":"Reference","previous_headings":"","what":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"Taking object makeme(), function estimates height figure horizontal bar chart.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"","code":"fig_height_h_barchart2(   ggobj,   freq = FALSE,   x_axis_label_width = 20,   strip_angle = 0,   main_font_size = 8,   legend_location = c(\"panel\", \"plot\"),   n_legend_lines = 2,   legend_key_chars_equivalence = 5,   max_chars_per_figure_width = 100,   multiplier_per_horizontal_line = NULL,   multiplier_per_vertical_letter = 0.01,   multiplier_per_facet = 0.95,   multiplier_per_legend_line = 1.5,   fixed_constant = 0,   figure_width_in_cm = 16,   margin_in_cm = 0,   max = 8,   min = 1 )"},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"ggobj ggplot2-object freq Logical. TRUE, frequency plot categories next . FALSE (default), proportion plot stacked categories. x_axis_label_width Numeric. Width allocated x-axis labels. strip_angle Integer. Angle strip text. main_font_size Numeric. Font size main text. legend_location Character. Location legend (\"panel\" \"plot\"). n_legend_lines Integer. Number lines legend. legend_key_chars_equivalence Integer. Approximate number characters legend key equals. max_chars_per_figure_width Integer. Maximum number characters per figure width. multiplier_per_horizontal_line Numeric. Multiplier per horizontal line. multiplier_per_vertical_letter Numeric. Multiplier per vertical letter. multiplier_per_facet Numeric. Multiplier per facet. multiplier_per_legend_line Numeric. Multiplier per legend line. fixed_constant Numeric. Fixed constant added height. figure_width_in_cm Numeric. Width figure centimeters. margin_in_cm Numeric. Margin centimeters. max Numeric. Maximum height. min Numeric. Minimum height.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"Numeric value representing estimated height figure.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/fig_height_h_barchart2.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Estimate figure height for a horizontal bar chart — fig_height_h_barchart2","text":"","code":"fig_height_h_barchart2(makeme(data=ex_survey, dep=b_1:b_3, indep=x1_sex)) #> [1] 2.58"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_palette.html","id":null,"dir":"Reference","previous_headings":"","what":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","text":"Possibly using colour_palette_nominal available. sufficient, uses set palette RColorBrewer.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_palette.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","text":"","code":"get_colour_palette(   data,   col_pos,   colour_palette_nominal = NULL,   colour_palette_ordinal = NULL,   colour_na = NULL,   categories_treated_as_na = NULL,   call = rlang::caller_env() )"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_palette.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","text":"data data.frame/tibble srvyr-object (experimental) data.frame // required data used plotting. col_pos Character vector column names colours found. colour_palette_nominal, colour_palette_ordinal User specified colour set vector<character> // default: NULL (optional) User-supplied default palette, excluding colour_na. colour_na Colour NA category scalar<character> // default: NULL (optional) Colour single string NA values, showNA \"ifany\" \"always\". categories_treated_as_na NA categories vector<character> // default: NULL (optional) Categories treated NA. call Internal call obj:<call> // Default: rlang::caller_env() (optional) absolute relative folderpaths required, strings.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_palette.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_palette","text":"colour set character vector, NA colour_na, rest taken colour_palette_nominal available.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_set.html","id":null,"dir":"Reference","previous_headings":"","what":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","text":"Possibly using colour_palette_nominal available. sufficient, uses set palette RColorBrewer.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_set.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","text":"","code":"get_colour_set(   x,   common_data_type = \"factor\",   colour_palette_nominal = NULL,   colour_palette_ordinal = NULL,   colour_na = NULL,   colour_2nd_binary_cat = NULL,   ordinal = FALSE,   categories_treated_as_na = NULL,   call = rlang::caller_env() )"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_set.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","text":"x Vector colours found. common_data_type factor ordered data type scalar<character> // default: factor (optional) Currently supports factor ordered. colour_palette_nominal, colour_palette_ordinal User specified colour set vector<character> // default: NULL (optional) User-supplied default palette, excluding colour_na. colour_na Colour NA category scalar<character> // default: NULL (optional) Colour single string NA values, showNA \"ifany\" \"always\". colour_2nd_binary_cat Colour second binary category scalar<character> // default: \"#ffffff\" (optional) Colour second category binary variables. Often useful hide . ordinal scalar<logical> // default: FALSE (optional) palette ordinal? categories_treated_as_na NA categories vector<character> // default: NULL (optional) Categories treated NA. call Internal call obj:<call> // Default: rlang::caller_env() (optional) absolute relative folderpaths required, strings.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_colour_set.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provide A Colour Set for A Number of Requested Colours — get_colour_set","text":"colour set character vector, NA colour_na, rest taken colour_palette_nominal available.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_data_label_opts.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Valid Data Labels for Figures and Tables — get_data_label_opts","title":"Get Valid Data Labels for Figures and Tables — get_data_label_opts","text":"Get Valid Data Labels Figures Tables","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_data_label_opts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Valid Data Labels for Figures and Tables — get_data_label_opts","text":"","code":"get_data_label_opts()"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_data_label_opts.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Valid Data Labels for Figures and Tables — get_data_label_opts","text":"Character vector","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":null,"dir":"Reference","previous_headings":"","what":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"makeme()-function take argument type one several strings indicate content type output type. function collects registered alternatives. Extensions possible, see . Built-types: Whereas names types can arbitrary, pattern pursued built-types. Prefix indicates dependent data type intended \"cat\" Categorical (ordinal nominal) data. \"chr\" Open ended responses character data. \"int\" Integer numeric data. Suffix indicates output \"html\" Interactive html, usually want Quarto, Quarto can usually convert formats needed \"docx\" However, Quarto's Pandoc's docx-support currently still limited, instance vector graphics converted raster graphics docx output. Hence, saros.contents offers types outputs MS Chart vector graphics. Note experimental actively developed. \"pdf\" basically just shortcut \"html\" interactive=FALSE","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"","code":"get_makeme_types()"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"Character vector","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"further-details-about-some-of-the-built-in-types-","dir":"Reference","previous_headings":"","what":"Further details about some of the built-in types:","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"\"cat_plot_\" Likert style plot groups categorical variables sharing categories. \"cat_table_\" Likert style table. \"chr_table_\" single-column table listing unique open ended responses. \"sigtest_table_\" See sigtest_table_\\*: Make Table Combinations Univariate/Bivariate Significance Tests Based Variable Types Although hundreds significance tests associations two variables, depending upon distributions, variables types assumptions, fall smaller set popular tests. function runs combinations dependent independent variables data, suitable test (possible) combination. Also supports univariate tests, assumptions mean zero continuous variables equal proportions binary/categorical. function allow adjustments - use original underlying functions (chisq.test, t.test, etc.)","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"expanding-with-custom-types","dir":"Reference","previous_headings":"","what":"Expanding with custom types","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"makeme() calls generic make_content(), uses S3-method system dispatch relevant method (.e., paste0(\"make_content.\", type)). makeme forwards arguments make_content, following exceptions: dep indep converted dplyr::dplyr_tidy_select()-syntax simple character vectors, simplifying building functions. data_summary attached, contains many useful pieces info many (categorical) displays.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_makeme_types.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get all registered options for the type-argument in the makeme-function — get_makeme_types","text":"","code":"get_makeme_types() #> [1] \"cat_freq_plot_docx\" \"cat_plot_html\"      \"cat_prop_plot_docx\" #> [4] \"cat_table_html\"     \"chr_table_html\"     \"sigtest_table_html\""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_raw_labels.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function to extract raw variable labels from the data — get_raw_labels","title":"Helper function to extract raw variable labels from the data — get_raw_labels","text":"Helper function extract raw variable labels data","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_raw_labels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function to extract raw variable labels from the data — get_raw_labels","text":"","code":"get_raw_labels(data, col_pos = NULL, return_as_list = FALSE)"},{"path":"https://nifu-no.github.io/saros.contents/reference/get_raw_labels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function to extract raw variable labels from the data — get_raw_labels","text":"data Dataset col_pos Optional, character vector column names integer vector positions return_as_list Flag, whether return list character vector","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/get_raw_labels.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function to extract raw variable labels from the data — get_raw_labels","text":"List character vector","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":null,"dir":"Reference","previous_headings":"","what":"Wrapper Function for ggplot2::ggsave() — ggsaver","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"exists make easy use make_link()","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"","code":"ggsaver(plot, filename, ...)"},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"plot Plot filename Note ... Arguments forwarded ggplot2::ggsave()","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"return value, called side effects","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/ggsaver.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Wrapper Function for ggplot2::ggsave() — ggsaver","text":"","code":"library(ggplot2) my_plot <- ggplot(data=mtcars, aes(x=hp, y=mpg)) + geom_point() make_link(my_plot, folder=tempdir(), file_suffix = \".png\",           save_fn = ggsaver, width = 16, height = 16, units = \"cm\") #> [1] \"[download figure data](/tmp/RtmpPE2Usf/9c80c3411afb3306e71208c23c27e10c.png)\""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Global Options for saros-functions — global_settings_get","title":"Get Global Options for saros-functions — global_settings_get","text":"Get Global Options saros-functions","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Global Options for saros-functions — global_settings_get","text":"","code":"global_settings_get(fn_name = \"makeme\")"},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Global Options for saros-functions — global_settings_get","text":"fn_name String, one \"make_link\", \"fig_height_h_barchart\" \"makeme\".","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Global Options for saros-functions — global_settings_get","text":"List options R","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Global Options for saros-functions — global_settings_get","text":"","code":"global_settings_get() #> $type #> [1] \"cat_plot_html\" #>  #> $require_common_categories #> [1] TRUE #>  #> $crowd #> [1] \"all\" #>  #> $mesos_var #> NULL #>  #> $mesos_group #> NULL #>  #> $simplify_output #> [1] TRUE #>  #> $hide_for_crowd_if_all_na #> [1] TRUE #>  #> $hide_for_crowd_if_valid_n_below #> [1] 0 #>  #> $hide_for_crowd_if_category_k_below #> [1] 2 #>  #> $hide_for_crowd_if_category_n_below #> [1] 0 #>  #> $hide_for_crowd_if_cell_n_below #> [1] 0 #>  #> $hide_for_all_crowds_if_hidden_for_crowd #> NULL #>  #> $hide_indep_cat_for_all_crowds_if_hidden_for_crowd #> [1] FALSE #>  #> $add_n_to_label #> [1] FALSE #>  #> $add_n_to_category #> [1] FALSE #>  #> $totals #> [1] FALSE #>  #> $categories_treated_as_na #> NULL #>  #> $label_separator #> [1] \" - \" #>  #> $showNA #> [1] \"ifany\" #>  #> $data_label #> [1] \"percentage_bare\" #>  #> $html_interactive #> [1] TRUE #>  #> $hide_axis_text_if_single_variable #> [1] TRUE #>  #> $hide_label_if_prop_below #> [1] 0.01 #>  #> $inverse #> [1] FALSE #>  #> $vertical #> [1] FALSE #>  #> $digits #> [1] 0 #>  #> $data_label_decimal_symbol #> [1] \".\" #>  #> $x_axis_label_width #> [1] 25 #>  #> $strip_width #> [1] 25 #>  #> $sort_by #> [1] \".upper\" #>  #> $descend #> [1] TRUE #>  #> $variables_always_at_top #> NULL #>  #> $variables_always_at_bottom #> NULL #>  #> $table_wide #> [1] TRUE #>  #> $table_main_question_as_header #> [1] FALSE #>  #> $translations #> $translations$last_sep #> [1] \" and \" #>  #> $translations$table_heading_N #> [1] \"Total (N)\" #>  #> $translations$add_n_to_label_prefix #> [1] \" (N = \" #>  #> $translations$add_n_to_label_suffix #> [1] \")\" #>  #> $translations$add_n_to_category_prefix #> [1] \" (N = [\" #>  #> $translations$add_n_to_category_infix #> [1] \",\" #>  #> $translations$add_n_to_category_suffix #> [1] \"])\" #>  #> $translations$by_total #> [1] \"Everyone\" #>  #> $translations$sigtest_variable_header_1 #> [1] \"Var 1\" #>  #> $translations$sigtest_variable_header_2 #> [1] \"Var 2\" #>  #> $translations$crowd_all #> [1] \"All\" #>  #> $translations$crowd_target #> [1] \"Target\" #>  #> $translations$crowd_others #> [1] \"Others\" #>  #>  #> $plot_height #> [1] 15 #>  #> $colour_palette #> NULL #>  #> $colour_2nd_binary_cat #> [1] \"#ffffff\" #>  #> $colour_na #> [1] \"grey\" #>  #> $label_font_size #> [1] 6 #>  #> $main_font_size #> [1] 6 #>  #> $strip_font_size #> [1] 6 #>  #> $legend_font_size #> [1] 6 #>  #> $font_family #> [1] \"sans\" #>  #> $path #> NULL #>  #> $docx_template #> NULL #>"},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":null,"dir":"Reference","previous_headings":"","what":"Reset Global Options for saros-functions — global_settings_reset","title":"Reset Global Options for saros-functions — global_settings_reset","text":"Reset Global Options saros-functions","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reset Global Options for saros-functions — global_settings_reset","text":"","code":"global_settings_reset(fn_name = \"makeme\")"},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reset Global Options for saros-functions — global_settings_reset","text":"fn_name String, one \"make_link\", \"fig_height_h_barchart\" \"makeme\".","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reset Global Options for saros-functions — global_settings_reset","text":"Invisibly returned list old new values.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_reset.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reset Global Options for saros-functions — global_settings_reset","text":"","code":"global_settings_reset() #> \"options('saros')$makeme_defaults\" has now been reset to factory defaults."},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Global Options for saros-functions — global_settings_set","title":"Get Global Options for saros-functions — global_settings_set","text":"Get Global Options saros-functions","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Global Options for saros-functions — global_settings_set","text":"","code":"global_settings_set(new, fn_name = \"makeme\", quiet = FALSE)"},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Global Options for saros-functions — global_settings_set","text":"new List arguments (see ?make_link(), ?makeme(), fig_height_h_barchart()) fn_name String, one \"make_link\", \"fig_height_h_barchart\" \"makeme\". quiet Flag. FALSE (default), informs set.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Global Options for saros-functions — global_settings_set","text":"Invisibly returned list old new values.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/global_settings_set.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Global Options for saros-functions — global_settings_set","text":"","code":"global_settings_set(new=list(digits=2)) #> `options('saros')$makeme_defaults` has now been set."},{"path":"https://nifu-no.github.io/saros.contents/reference/hex_bw.html","id":null,"dir":"Reference","previous_headings":"","what":"Identify Suitable Font Given Background Hex Colour — hex_bw","title":"Identify Suitable Font Given Background Hex Colour — hex_bw","text":"Code taken XXX.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/hex_bw.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Identify Suitable Font Given Background Hex Colour — hex_bw","text":"","code":"hex_bw(hex_code)"},{"path":"https://nifu-no.github.io/saros.contents/reference/hex_bw.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Identify Suitable Font Given Background Hex Colour — hex_bw","text":"hex_code Colour hex-format.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/hex_bw.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Identify Suitable Font Given Background Hex Colour — hex_bw","text":"Colours hex-format, either black white.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_colour.html","id":null,"dir":"Reference","previous_headings":"","what":"Are All Colours in Vector Valid Colours — is_colour","title":"Are All Colours in Vector Valid Colours — is_colour","text":"title says. : (https://stackoverflow.com//13290832/3315962)","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_colour.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Are All Colours in Vector Valid Colours — is_colour","text":"","code":"is_colour(x)"},{"path":"https://nifu-no.github.io/saros.contents/reference/is_colour.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Are All Colours in Vector Valid Colours — is_colour","text":"x Character vector colours hex-format.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_colour.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Are All Colours in Vector Valid Colours — is_colour","text":"Logical, error.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_string.html","id":null,"dir":"Reference","previous_headings":"","what":"Is x A String? — is_string","title":"Is x A String? — is_string","text":"Returns TRUE object character length 1.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_string.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is x A String? — is_string","text":"","code":"is_string(x)"},{"path":"https://nifu-no.github.io/saros.contents/reference/is_string.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is x A String? — is_string","text":"x Object","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/is_string.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is x A String? — is_string","text":"Logical value.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_content.html","id":null,"dir":"Reference","previous_headings":"","what":"Method for Creating Saros Contents — make_content","title":"Method for Creating Saros Contents — make_content","text":"Takes arguments makeme, except dep indep make_content character vectors, ease user-customized function programming.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_content.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Method for Creating Saros Contents — make_content","text":"","code":"make_content(type, ...)"},{"path":"https://nifu-no.github.io/saros.contents/reference/make_content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Method for Creating Saros Contents — make_content","text":"type Method name scalar<character> class named . Optional string indicating specific method. Occasionally useful error messages, etc. ... Dots Arguments provided makeme","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_content.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Method for Creating Saros Contents — make_content","text":"returned object class depends type. type=\"*_table_html\" always returns tibble. type=\"*_plot_html\" always returns ggplot. type=\"*_docx\" always returns rdocx object path=NULL, side-effect writing docx file disk path set.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":null,"dir":"Reference","previous_headings":"","what":"Save data to a file and return a Markdown link — make_link","title":"Save data to a file and return a Markdown link — make_link","text":"file automatically named hash object, removing need come unique file names inside Quarto report. added benefit reducing storage needs objects needing linking identical, stored folder. also allows user download multiple files without worrying accidentally overwriting .","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save data to a file and return a Markdown link — make_link","text":"","code":"make_link(   data,   folder = NULL,   file_prefix = NULL,   file_suffix = \".csv\",   save_fn = utils::write.csv,   link_prefix = \"[download figure data](\",   link_suffix = \")\",   ... )"},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save data to a file and return a Markdown link — make_link","text":"data Data object <data.frame|tbl|obj> Data frame using tabular data save_fn, possibly R object, serializing save_fn provided (e.g. saveRDS()). folder store file scalar<character> // default: \".\" (optional) Defaults folder. file_prefix, file_suffix File prefix/suffix scalar<character> // default: \"\" \".csv\" (optional) file_suffix include dot extension. save_fn Saving function function // default: utils::write.csv Can saving/writing function. However, first argument must object saved, second must path. Hence, ggplot2::ggsave() must wrapped another function filename object swapped. See ggsaver() example wrapper function. link_prefix, link_suffix Link prefix/suffix scalar<character> // default: \"[download data](\" \")\" stuff returned. ... Dynamic dots <dynamic-dots> Arguments forwarded corresponding functions create elements.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Save data to a file and return a Markdown link — make_link","text":"String.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/make_link.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Save data to a file and return a Markdown link — make_link","text":"","code":"make_link(mtcars, folder=tempdir()) #> [1] \"[download figure data](/tmp/RtmpPE2Usf/d0487363db4e6cc64fdb740cb6617fc0.csv)\""},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":null,"dir":"Reference","previous_headings":"","what":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"function allows embedding interactive static plots based various types data using tidyselect syntax variable selection.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"","code":"makeme(   data,   dep = tidyselect::everything(),   indep = NULL,   type = c(\"cat_plot_html\", \"int_plot_html\", \"cat_table_html\", \"int_table_html\",     \"sigtest_table_html\", \"cat_prop_plot_docx\", \"cat_freq_plot_docx\", \"int_plot_docx\"),   ...,   require_common_categories = TRUE,   crowd = c(\"all\"),   mesos_var = NULL,   mesos_group = NULL,   simplify_output = TRUE,   hide_for_crowd_if_all_na = TRUE,   hide_for_crowd_if_valid_n_below = 0,   hide_for_crowd_if_category_k_below = 2,   hide_for_crowd_if_category_n_below = 0,   hide_for_crowd_if_cell_n_below = 0,   hide_for_all_crowds_if_hidden_for_crowd = NULL,   hide_indep_cat_for_all_crowds_if_hidden_for_crowd = FALSE,   add_n_to_label = FALSE,   add_n_to_category = FALSE,   totals = FALSE,   categories_treated_as_na = NULL,   label_separator = \" - \",   showNA = c(\"ifany\", \"always\", \"never\"),   data_label = c(\"percentage_bare\", \"percentage\", \"proportion\", \"count\"),   html_interactive = TRUE,   hide_axis_text_if_single_variable = TRUE,   hide_label_if_prop_below = 0.01,   inverse = FALSE,   vertical = FALSE,   digits = 0,   data_label_decimal_symbol = \".\",   x_axis_label_width = 25,   strip_width = 25,   sort_by = \".upper\",   descend = TRUE,   variables_always_at_top = NULL,   variables_always_at_bottom = NULL,   table_wide = TRUE,   table_main_question_as_header = FALSE,   translations = list(last_sep = \" and \", table_heading_N = \"Total (N)\",     add_n_to_label_prefix = \" (N = \", add_n_to_label_suffix = \")\",     add_n_to_category_prefix = \" (N = [\", add_n_to_category_infix = \",\",     add_n_to_category_suffix = \"])\", by_total = \"Everyone\", sigtest_variable_header_1 =     \"Var 1\", sigtest_variable_header_2 = \"Var 2\", crowd_all = \"All\", crowd_target =     \"Target\", crowd_others = \"Others\"),   plot_height = 15,   colour_palette = NULL,   colour_2nd_binary_cat = \"#ffffff\",   colour_na = \"grey\",   label_font_size = 6,   main_font_size = 6,   strip_font_size = 6,   legend_font_size = 6,   font_family = \"sans\",   path = NULL,   docx_template = NULL )"},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"data data.frame/tibble srvyr-object (experimental) data.frame // required data used plotting. dep, indep Variable selections <tidyselect> // Default: NULL, meaning everything dep, nothing indep. Columns data. dep compulsory. type Kind output scalar<character> // default: \"prop_plot\" (optional) list registered types session, use get_makeme_types(). ... Dynamic dots <dynamic-dots> Arguments forwarded corresponding functions create elements. require_common_categories Check common categories scalar<logical> // default: NULL (optional) Whether check items share common categories. crowd group(s) display results vector<character> // default: c(\"target\", \"others\", \"\") (optional) Choose whether produce results target (mesos) group, others, , combinations . mesos_var Variable data indicating groups tailor reports scalar<character> // default: NULL (optional) Column name data indicating groups mesos reports produced. mesos_group scalar<character> // default: NULL (optional) String, target group. simplify_output scalar<logical> // default: TRUE TRUE, list output single output element return element , whereas list multiple elements return list. hide_for_crowd_if_all_na Hide variable output containing NA scalar<boolean> // default: TRUE Whether remove variables (particular useful mesos) values NA hide_for_crowd_if_valid_n_below Hide variable variable < n observations scalar<integer> // default: 0 Whether hide variable crowd variable contains fewer n observations (always ignoring NA). hide_for_crowd_if_category_k_below Hide variable < k categories scalar<integer> // default: 2 Whether hide variable crowd variable contains fewer k used categories (always ignoring NA). Defaults 2 unitary plot/table rarely informative. hide_for_crowd_if_category_n_below Hide variable category < n observations scalar<integer> // default: 0 Whether hide variable crowd variable contains category less n observations (ignoring NA) Cells 0 count considered usually problem anonymity. hide_for_crowd_if_cell_n_below Hide variable cell < n scalar<integer> // default: 0 Whether hide variable crowd combination dep-indep results cell less n observations (ignoring NA). Cells 0 count considered usually problem anonymity. hide_for_all_crowds_if_hidden_for_crowd Conditional hiding scalar<character> // default: NULL (optional) Select one crowd output groups. selected, hide variable across crowd-outputs reason displayed hide_for_all_if_hidden_for_crowd. instance, say: crowd = c(\"target\", \"others\"), hide_variable_if_all_na = TRUE, hide_for_all_if_hidden_for_crowd = \"target\" hide variables target others-outputs NA target-group. hide_indep_cat_for_all_crowds_if_hidden_for_crowd Conditionally hide independent categories scalar<logical> // default: FALSE hide_for_all_crowds_if_hidden_for_crowd specified, categories indep variable(s) hidden crowd exist crowds specified hide_for_all_crowds_if_hidden_for_crowd? useful e.g. indep academic disciplines, mesos_var institutions, specific institution interested seeing academic disciplines offer . add_n_to_label Add N= variable label scalar<logical> // default: FALSE (optional) plots tables useful attach \"N=\" end label. Whether N N_valid depends showNA-setting. See also translations$add_n_to_label_prefix translations$add_n_to_label_suffix. add_n_to_category Add N= category scalar<logical> // default: FALSE (optional) plots tables useful attach \"N=\" end category. likely produce range across variables, hence infix (comma) minimum maximum can specified. Whether N N_valid depends showNA-setting. See also translations$add_n_to_category_prefix, translations$add_n_to_category_infix, translations$add_n_to_category_suffix. totals Include totals scalar<logical> // default: FALSE (optional) Whether include totals output. categories_treated_as_na NA categories vector<character> // default: NULL (optional) Categories treated NA. label_separator separate main question sub-question scalar<character> // default: NULL (optional) Separator main question sub-question. showNA Show NA categories vector<character> // default: c(\"ifany\", \"always\", \"never\") (optional) Choose whether show NA categories results. data_label Data label scalar<character> // default: \"proportion\" (optional) One \"proportion\", \"percentage\", \"percentage_bare\", \"count\", \"mean\", \"median\". html_interactive Toggle interactive plot scalar<logical> // default: TRUE (optional) Whether plot interactive (ggiraph) static (ggplot2). hide_axis_text_if_single_variable Hide y-axis text just single variable scalar<boolean> // default: FALSE (optional) Whether hide text y-axis label just single variable. hide_label_if_prop_below Hide label threshold scalar<numeric> // default: NULL (optional) Whether hide label value. inverse Flag swap x-axis faceting scalar<logical> // default: FALSE (optional) TRUE, swaps x-axis faceting. vertical Display plot vertically scalar<logical> // default: FALSE (optional) TRUE, display plot vertically. digits Decimal places scalar<integer> // default: 0L (optional) Number decimal places. data_label_decimal_symbol Decimal symbol scalar<character> // default: \".\" (optional) Decimal marker, might prefer comma ',' something else entirely. x_axis_label_width, strip_width Label width x-axis strip texts plots scalar<integer> // default: 20 (optional) Width labels used categorical column names x-axis texts strip texts. sort_by sort output vector<character> // default: NULL (optional) Sort output (collapse requested). using indep-argument, sorting differs ordered factors unordered factors: Ordering ordered factors always respected output. Unordered factors reordered sort_by. Currently, works best single dep. \".top\" proportion highest category available variable. \".upper\" sum proportions categories middle category. \".mid_upper\" sum proportions categories including middle category. \".mid_lower\" sum proportions categories including middle category. \".lower\" sum proportions categories middle category. \".bottom\" proportions lowest category available variable. \".variable_label\" Sort variable labels. \".id\" Sort variable names. \".by_group\" groups argument. character() Character vector category labels sum together. descend Sorting order scalar<logical> // default: FALSE (optional) Reverse sorting sort_by figures tables. See arrange_section_by sorting report sections. variables_always_at_top, variables_always_at_bottom Top/bottom variables vector<character> // default: NULL (optional) Column names data always placed top bottom figures/tables. table_wide Pivot table wider scalar<logical> // default: FALSE (optional) Whether pivot table wider. table_main_question_as_header Table main question header scalar<logical> // default: FALSE (optional) Whether include main question header table. translations Localize output list<character> list translations name code value translation. See examples. plot_height DOCX-setting scalar<numeric> // default: 12 (optional) DOCX plots need height, currently set easily Quarto chunk option. colour_palette Colour palette vector<character> // default: NULL (optional) Must contain least number unique values (including missing) data set. colour_2nd_binary_cat Colour second binary category scalar<character> // default: \"#ffffff\" (optional) Colour second category binary variables. Often useful hide . colour_na Colour NA category scalar<character> // default: NULL (optional) Colour single string NA values, showNA \"ifany\" \"always\". main_font_size, label_font_size, strip_font_size, legend_font_size Font sizes scalar<integer> // default: 6 (optional) DOCX-OUTPUT. output adjusted using e.g. ggplot2::theme() set global theme (ggplot2::theme_set()). Font sizes general text (6), data label text (3), strip text (6) legend text (6). font_family Font family scalar<character> // default: \"sans\" (optional) Word font family. See officer::fp_text. path Output path DOCX scalar<character> // default: NULL (optional) Path save docx-output. docx_template Filename rdocx object scalar<character>|<rdocx>-object // default: NULL (optional) Can either valid character path reference Word file, existing rdocx-object memory.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"ggplot-object, optionally extended ggplot object ggiraph features.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/makeme.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Embed Interactive Plot of Various Kinds Using Tidyselect Syntax — makeme","text":"","code":"makeme(data = ex_survey,        dep = b_1:b_3)  makeme(data = ex_survey,        dep = b_1, indep = x1_sex)  makeme(data = ex_survey,        dep = b_1:b_3, indep = c(x1_sex, x2_human),        type = \"sigtest_table_html\") #>   Var 1    Var 2                         .bi_test  .p_value n_valid_Males #> 1   b_1   x1_sex Chi-squared Goodness-of-Fit Test 0.7280089           151 #> 2   b_1 x2_human Chi-squared Goodness-of-Fit Test 0.5363252            NA #> 3   b_2   x1_sex Chi-squared Goodness-of-Fit Test 0.4474979           151 #> 4   b_2 x2_human Chi-squared Goodness-of-Fit Test 0.9552449            NA #> 5   b_3   x1_sex Chi-squared Goodness-of-Fit Test 0.8496092           151 #> 6   b_3 x2_human Chi-squared Goodness-of-Fit Test 0.2604879            NA #>   n_valid_Females n_Males n_Females n_valid_Definitely humanoid n_valid_Robot? #> 1             149     151       149                          NA             NA #> 2              NA      NA        NA                         144            156 #> 3             149     151       149                          NA             NA #> 4              NA      NA        NA                         144            156 #> 5             149     151       149                          NA             NA #> 6              NA      NA        NA                         144            156 #>   n_Definitely humanoid n_Robot? #> 1                    NA       NA #> 2                   144      156 #> 3                    NA       NA #> 4                   144      156 #> 5                    NA       NA #> 6                   144      156 makeme(data = ex_survey,        dep = b_1, indep = x1_sex,        type = \"cat_prop_plot_docx\") #> rdocx document with 2 element(s) #>  #> * styles: #>                 Normal              heading 1              heading 2  #>            \"paragraph\"            \"paragraph\"            \"paragraph\"  #>              heading 3 Default Paragraph Font           Normal Table  #>            \"paragraph\"            \"character\"                \"table\"  #>                No List                 strong               centered  #>            \"numbering\"            \"character\"            \"paragraph\"  #>         table_template    Light List Accent 2            Titre 1 Car  #>                \"table\"                \"table\"            \"character\"  #>            Titre 2 Car            Titre 3 Car          Image Caption  #>            \"character\"            \"character\"            \"paragraph\"  #>          Table Caption     Table Professional                  toc 1  #>            \"paragraph\"                \"table\"            \"paragraph\"  #>                  toc 2           Balloon Text    Texte de bulles Car  #>            \"paragraph\"            \"paragraph\"            \"character\"  #>           reference_id          graphic title            table title  #>            \"character\"            \"paragraph\"            \"paragraph\"  #>  #> * Content at cursor location: #>   level num_id text style_name content_type #> 1    NA     NA          Normal    paragraph makeme(data = ex_survey,        dep = p_1:p_4, indep = x2_human,        type = \"cat_table_html\") #> # A tibble: 8 × 8 #>   .variable_label `Is respondent human?` `Strongly disagree (%)` #>   <ord>           <fct>                  <chr>                   #> 1 Yellow Party    Robot?                 16.03                   #> 2 Yellow Party    Definitely humanoid    20.83                   #> 3 Blue Party      Robot?                 26.28                   #> 4 Blue Party      Definitely humanoid    19.44                   #> 5 Green Party     Robot?                 25.00                   #> 6 Green Party     Definitely humanoid    13.89                   #> 7 Red Party       Robot?                 19.23                   #> 8 Red Party       Definitely humanoid    16.67                   #> # ℹ 5 more variables: `Somewhat disagree (%)` <chr>, #> #   `Somewhat agree (%)` <chr>, `Strongly agree (%)` <chr>, `NA (%)` <chr>, #> #   `Total (N)` <int> makeme(data = ex_survey,        dep = b_1:b_3,        crowd = c(\"target\", \"others\", \"all\"),        mesos_var = \"f_uni\",        mesos_group = \"Uni of A\") #> $Target  #>  #> $Others  #>  #> $All  #>"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":null,"dir":"Reference","previous_headings":"","what":"Provides a range (or single value) for N in data, given dep and indep — n_range","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"Provides range (single value) N data, given dep indep","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"","code":"n_range(   data,   dep,   indep = NULL,   mesos_var = NULL,   mesos_group = NULL,   glue_template_1 = \"{n}\",   glue_template_2 = \"[{n[1]}-{n[2]}]\" )"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"data Dataset dep, indep Tidyselect syntax mesos_var Optional, NULL string specifying name variable used split dataset. mesos_group Optional, NULL string specifying value mesos_var indicating target group. glue_template_1, glue_template_2 String, case single value (1) range minimum-maximum values (2).","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"String.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Provides a range (or single value) for N in data, given dep and indep — n_range","text":"","code":"n_range(data=ex_survey, dep=b_1:b_3, indep=x1_sex) #> 300"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":null,"dir":"Reference","previous_headings":"","what":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"Provides range (single value) N ggplot2-object makeme()","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"","code":"n_range2(ggobj, glue_template_1 = \"{n}\", glue_template_2 = \"[{n[1]}-{n[2]}]\")"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"ggobj ggplot2-object. glue_template_1, glue_template_2 String, case single value (1) range minimum-maximum values (2).","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"String.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_range2.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Provides a range (or single value) for N in a ggplot2-object from makeme() — n_range2","text":"","code":"n_range2(makeme(data = ex_survey, dep = b_1:b_3)) #> 300"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng.html","id":null,"dir":"Reference","previous_headings":"","what":"Obtain range of N for a given data set and other settings. — n_rng","title":"Obtain range of N for a given data set and other settings. — n_rng","text":"Obtain range N given data set settings.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Obtain range of N for a given data set and other settings. — n_rng","text":"","code":"n_rng(   data,   dep,   indep = NULL,   crowd = \"all\",   mesos_var = NULL,   mesos_group = NULL,   glue_template_1 = \"{n}\",   glue_template_2 = \"[{n[1]}-{n[2]}]\" )"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Obtain range of N for a given data set and other settings. — n_rng","text":"data Dataset dep, indep Character vector, names ()dependent variables crowd String, one \"\", \"target\" \"others\". mesos_var Optional, NULL string specifying name variable used split dataset. mesos_group Optional, NULL string specifying value mesos_var indicating target group. glue_template_1, glue_template_2 String, case single value (1) range minimum-maximum values (2).","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Obtain range of N for a given data set and other settings. — n_rng","text":"Always string.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng2.html","id":null,"dir":"Reference","previous_headings":"","what":"Obtain range of N for a given ggobj. — n_rng2","title":"Obtain range of N for a given ggobj. — n_rng2","text":"Obtain range N given ggobj.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Obtain range of N for a given ggobj. — n_rng2","text":"","code":"n_rng2(ggobj, glue_template_1 = \"{n}\", glue_template_2 = \"[{n[1]}-{n[2]}]\")"},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Obtain range of N for a given ggobj. — n_rng2","text":"ggobj ggplot2-object. glue_template_1, glue_template_2 String, case single value (1) range minimum-maximum values (2).","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/n_rng2.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Obtain range of N for a given ggobj. — n_rng2","text":"Always string.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":null,"dir":"Reference","previous_headings":"","what":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"Permission hereby granted, free charge, person obtaining copy software associated documentation files (\"Software\"), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions:","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"","code":"reorder_within(x, by, within, fun = mean, sep = \"___\", ...)"},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"\"Original: Ordering categories within ggplot2 Facets\" Tyler Rinker: https://trinkerrstuff.wordpress.com/2016/12/23/ordering-categories-within-ggplot2-facets/ Based https://opensource.org/licenses/MIT Copyright (c) 2017, Julia Silge David Robinson","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"x Vector Vector within Vector (factor) fun Function, defaults mean sep String, separator ... Dots","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/reorder_within.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Code-snippets copied and modified from tidytext-package https://github.com/juliasilge/tidytext/blob/main/R/reorder_within.R — reorder_within","text":"copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED \"\", WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/subset_vector.html","id":null,"dir":"Reference","previous_headings":"","what":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","title":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","text":"Useful identifying categories collected.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/subset_vector.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","text":"","code":"subset_vector(   vec,   set = c(\".top\", \".upper\", \".mid_upper\", \".lower\", \".mid_lower\", \".bottom\", \".spread\"),   spread_n = NULL,   sort = FALSE )"},{"path":"https://nifu-no.github.io/saros.contents/reference/subset_vector.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","text":"vec vector type. set character string, one c(\".top\", \".upper\", \".mid_upper\", \".lower\", \".mid_lower\", \".bottom\") spread_n number values extract set \"spread\". sort Whether sort output, defaults FALSE.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/subset_vector.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Given Ordered Integer Vector, Return Requested Set. — subset_vector","text":"Selected set vector.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/summarize_cat_cat_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","title":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","text":"Summarize survey dataset use tables graphs","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/summarize_cat_cat_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","text":"","code":"summarize_cat_cat_data(   data,   dep = colnames(data),   indep = NULL,   ...,   showNA = c(\"ifany\", \"always\", \"never\"),   totals = FALSE,   sort_by = \".upper\",   data_label = c(\"percentage_bare\", \"percentage\", \"proportion\", \"count\"),   digits = 0,   add_n_to_label = FALSE,   add_n_to_category = FALSE,   hide_label_if_prop_below = 0.01,   data_label_decimal_symbol = \".\",   categories_treated_as_na = NULL,   label_separator = NULL,   descend = FALSE,   variables_always_at_bottom = NULL,   variables_always_at_top = NULL,   translations = list(),   call = rlang::caller_env() )"},{"path":"https://nifu-no.github.io/saros.contents/reference/summarize_cat_cat_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","text":"data data.frame/tibble srvyr-object (experimental) data.frame // required data used plotting. dep, indep Variable selections <tidyselect> // Default: NULL, meaning everything dep, nothing indep. Columns data. dep compulsory. ... Dynamic dots <dynamic-dots> Arguments forwarded corresponding functions create elements. showNA Show NA categories vector<character> // default: c(\"ifany\", \"always\", \"never\") (optional) Choose whether show NA categories results. totals Include totals scalar<logical> // default: FALSE (optional) Whether include totals output. sort_by sort output vector<character> // default: NULL (optional) Sort output (collapse requested). using indep-argument, sorting differs ordered factors unordered factors: Ordering ordered factors always respected output. Unordered factors reordered sort_by. Currently, works best single dep. \".top\" proportion highest category available variable. \".upper\" sum proportions categories middle category. \".mid_upper\" sum proportions categories including middle category. \".mid_lower\" sum proportions categories including middle category. \".lower\" sum proportions categories middle category. \".bottom\" proportions lowest category available variable. \".variable_label\" Sort variable labels. \".id\" Sort variable names. \".by_group\" groups argument. character() Character vector category labels sum together. data_label Data label scalar<character> // default: \"proportion\" (optional) One \"proportion\", \"percentage\", \"percentage_bare\", \"count\", \"mean\", \"median\". digits Decimal places scalar<integer> // default: 0L (optional) Number decimal places. add_n_to_label Add N= variable label scalar<logical> // default: FALSE (optional) plots tables useful attach \"N=\" end label. Whether N N_valid depends showNA-setting. See also translations$add_n_to_label_prefix translations$add_n_to_label_suffix. add_n_to_category Add N= category scalar<logical> // default: FALSE (optional) plots tables useful attach \"N=\" end category. likely produce range across variables, hence infix (comma) minimum maximum can specified. Whether N N_valid depends showNA-setting. See also translations$add_n_to_category_prefix, translations$add_n_to_category_infix, translations$add_n_to_category_suffix. hide_label_if_prop_below Hide label threshold scalar<numeric> // default: NULL (optional) Whether hide label value. data_label_decimal_symbol Decimal symbol scalar<character> // default: \".\" (optional) Decimal marker, might prefer comma ',' something else entirely. categories_treated_as_na NA categories vector<character> // default: NULL (optional) Categories treated NA. label_separator separate main question sub-question scalar<character> // default: NULL (optional) Separator main question sub-question. descend Sorting order scalar<logical> // default: FALSE (optional) Reverse sorting sort_by figures tables. See arrange_section_by sorting report sections. variables_always_at_top, variables_always_at_bottom Top/bottom variables vector<character> // default: NULL (optional) Column names data always placed top bottom figures/tables. translations Localize output list<character> list translations name code value translation. See examples. call Internal call obj:<call> // Default: rlang::caller_env() (optional) absolute relative folderpaths required, strings.","code":""},{"path":"https://nifu-no.github.io/saros.contents/reference/summarize_cat_cat_data.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Summarize a survey dataset for use in tables and graphs — summarize_cat_cat_data","text":"Dataset","code":""},{"path":"https://nifu-no.github.io/saros.contents/news/index.html","id":"saroscontents-010","dir":"Changelog","previous_headings":"","what":"saros.contents 0.1.0","title":"saros.contents 0.1.0","text":"Initial CRAN submission.","code":""}]