single_all_digits_test: Helper function for 'all_digits_test' to perform a single all...
In jlederluis/digitanalysis: Digit Analysis

View source: R/all_digit_test_main_function.R

single_all_digits_test

R Documentation

Helper function for `all_digits_test` to perform a single all digits test.

Description

Helper function for all_digits_test to perform a single all digits test.

Usage

single_all_digits_test(
  digitdata,
  contingency_table,
  data_columns,
  digit_places,
  skip_first_digit,
  omit_05,
  category,
  category_grouping,
  skip_last_digit,
  suppress_low_N,
  subset_name,
  plot,
  suppress_second_division_plots,
  save3Dfilename,
  kwargs
)

Arguments

`digitdata`	A object of class `DigitAnalysis`.
`contingency_table`	The user-input probability table of arbitrary distribution. Overwrites `distribution` if not NA. Must be a dataframe of the form as `benford_table`. Defaulted to NA. Check out `load(file = "data/benford_table.RData")` to see the format of `benford_table`
`data_columns`	The names of numeric columns of data to be analyzed. Default can be 'all', where using all data columns in `numbers` df in `digitdata`; an array of column names, as characters; a single column name, as character.
`digit_places`	The indexes of left-aligned digit places to analyze. There are three options: 'all': analyze all digits. Set as default. An numeric array: Perform multiple digit test on the digit places desired to analyze. A number: Perform single digit test on the digit place desired to analyze. If last digit test is desired, pass in -1 or c(-1).
`skip_first_digit`	TRUE or FALSE: If TRUE, skip first digit place before analysis. Default to FALSE.
`omit_05`	Whether to omit 0 or both 0 and 5. If omit both 0 and 5, pass in c(0,5) or c(5,0); if omit only 0 pass in 0 or c(0); if omit neither, pass in NA. Default to NA.
`category`	The column for splitting the data into sectors for separate analysis. The second division (usually variables) shown in plots.
`category_grouping`	A list of arrays, or defaulted to NA. Only effective if `category` is not NA. Each the names of the elements in the list is the category name Each array contains the values belonging to that category If it is remain as NA as default, while `category` is not NA, then `category_grouping` will default to every individual item in `category` will be in a separate group. e.g. `category_grouping = list(group_1=c(category_1, category_2, ...), group_2=c(category_10, ...), group_3=c(...))`
`skip_last_digit`	TRUE or FALSE: If TRUE, skip last digit place before analysis, since we don't want tests to overlap. Default to FALSE. `skip_last_digit` should overwrite `digit_places` and `skip_first_digits`.
`suppress_low_N`	TRUE or FALSE: If TRUE, suppress columns in expected table if at least one cell in that column has expected value < 5. Default to FALSE.
`subset_name`	The main title to put on plots for current test.
`plot`	TRUE or FALSE or 'Save': If TRUE, display the plots and return them. If 'Save', return the plots but suppress display. If FALSE, no plot is produced. Default to TRUE.
`suppress_second_division_plots`	TRUE or FALSE: If TRUE, suppress the display of all plots on second division.
`save3Dfilename`	If specified, will save the 3D barplot to apdf named as the input name + break out and category specification. Defaulted to ”.
`kwargs`	extra parameters to pass into 3D plotting; dnt use it now, error prone! Defaulted to NA. Don't try to use it!!!!!!!!!