479 improve documentation

[chlebowa]

Closes #479

[github-actions]

Unit Tests Summary

    1 files    28 suites   29s ⏱️
372 tests 372 ✔️ 0 💤 0 ❌
846 runs  846 ✔️ 0 💤 0 ❌

Results for commit ddd998c.

[github-actions]

Code Coverage Summary

Filename                      Stmts    Miss  Cover    Missing
--------------------------  -------  ------  -------  ---------------------------------------------------------------------------------------------------------------------------------------------------------------------
R/calls_combine_by.R              8       0  100.00%
R/choices_labeled.R              49      14  71.43%   22, 33, 38, 48-53, 65, 69-73
R/count_labels.R                 98       0  100.00%
R/filter_panel_api.R             37       2  94.59%   92, 104
R/FilteredData-utils.R          123      17  86.18%   109-114, 207, 229-238
R/FilteredData.R                588     226  61.56%   99-102, 167, 522-530, 599-608, 630, 651-692, 710-713, 729, 770-803, 818-820, 824-830, 856-884, 906-908, 912-914, 917-928, 932-941, 943-969, 987-1057, 1099, 1122-1144
R/FilteredDataset-utils.R        20       1  95.00%   133
R/FilteredDataset.R             179      67  62.57%   50, 149, 198-204, 232-289, 329-331
R/FilteredDatasetDefault.R      121       9  92.56%   69, 131, 141, 145, 228-232
R/FilteredDatasetMAE.R          134      37  72.39%   27, 113-118, 157-162, 166-167, 187-209
R/FilterPanelAPI.R               10       0  100.00%
R/FilterState-utils.R            97       1  98.97%   286
R/FilterState.R                 361      61  83.10%   88, 212, 230-234, 241-242, 256-257, 263-264, 312, 314, 316, 368, 412, 644, 687-712, 723-742, 777-783, 792-798
R/FilterStateChoices.R          338     106  68.64%   302-305, 317, 360, 384-391, 395-412, 441, 456-467, 479-487, 491-520, 541-544, 547-550, 561-582, 595-596, 606
R/FilterStateDate.R             212     129  39.15%   219, 272-430
R/FilterStateDatettime.R        307     199  35.18%   256, 309-541
R/FilterStateEmpty.R             53      31  41.51%   82, 92-97, 111, 125-166
R/FilterStateExpr.R              75      62  17.33%   138-262
R/FilterStateLogical.R          196     144  26.53%   127, 150, 210, 213-399
R/FilterStateRange.R            410     105  74.39%   254, 378, 506-510, 513-523, 526, 538-544, 555-567, 571-581, 585-587, 601-628, 643, 646, 661-678, 713-718, 728-730
R/FilterStates-utils.R           70       9  87.14%   102, 121, 179-185, 207, 234
R/FilterStates.R                364      30  91.76%   76-80, 189, 320-329, 417-420, 463, 548-552, 597, 718-721
R/FilterStatesDF.R                5       0  100.00%
R/FilterStatesMAE.R              10       1  90.00%   39
R/FilterStatesMatrix.R            3       0  100.00%
R/FilterStatesSE.R              211     157  25.59%   34, 69-71, 81-83, 107-114, 122-129, 152-300
R/include_css_js.R                5       5  0.00%    12-16
R/teal_slice.R                  107       2  98.13%   135, 201
R/teal_slices.R                 139       6  95.68%   144-149, 334
R/test_utils.R                   21       0  100.00%
R/utils.R                        49       2  95.92%   101-102
R/variable_types.R               48      33  31.25%   41-46, 56, 69-104
R/zzz.R                          15      15  0.00%    3-46
TOTAL                          4463    1471  67.04%

Diff against main

Filename                  Stmts    Miss  Cover
----------------------  -------  ------  -------
R/FilteredData-utils.R       +6       0  +0.71%
TOTAL                        +6       0  +0.04%

Results for commit: bb05060

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[chlebowa]

I seem to have branched off teal_data@main rather than main. Will redo.