input_check: Asserts the input to user accessible functions in this...

In jlederluis/digitanalysis: Digit Analysis

Asserts the input to user accessible functions in this package are of correct type and form.

Description

Asserts the input to user accessible functions in this package are of correct type and form.

Usage

input_check(
  digitdata,
  contingency_table = NA,
  data_columns = NA,
  digit_places = NA,
  skip_first_digit = NA,
  omit_05 = NA,
  break_out = NA,
  break_out_grouping = NA,
  distribution = NA,
  plot = NA,
  skip_last_digit = NA,
  rounding_split_column = NA,
  min_length = NA,
  duplicate_matching_cols = NA,
  category = NA,
  category_grouping = NA,
  high = NA,
  max_length = NA,
  num_digits = NA,
  N = NA,
  standard_df = NA,
  rounding_patterns = NA,
  suppress_low_N = NA,
  suppress_first_division_plots = NA,
  suppress_second_division_plots = NA,
  simulate = NA,
  remove_all_category_visualize = NA
)

Arguments

digitdata	Mandatory option. Check if it is of class DigitAnalysis
contingency_table	Defaulted to NA. Pass in to check if it is a valid input.
data_columns	Defaulted to NA. Pass in to check if it is a valid input.
digit_places	Defaulted to NA. Pass in to check if it is a valid input.
skip_first_digit	Defaulted to NA. Pass in to check if it is a valid input.
omit_05	Defaulted to NA. Pass in to check if it is a valid input.
break_out	Defaulted to NA. Pass in to check if it is a valid input.
break_out_grouping	Defaulted to NA. Pass in to check if it is a valid input.
distribution	Defaulted to NA. Pass in to check if it is a valid input.
plot	Defaulted to NA. Pass in to check if it is a valid input.
skip_last_digit	Defaulted to NA. Pass in to check if it is a valid input.
rounding_split_column	Defaulted to NA. Pass in to check if it is a valid input.
min_length	Defaulted to NA. Pass in to check if it is a valid input.
duplicate_matching_cols	Defaulted to NA. Pass in to check if it is a valid input.
category	Defaulted to NA. Pass in to check if it is a valid input.
category_grouping	Defaulted to NA. Pass in to check if it is a valid input.
high	Defaulted to NA. Pass in to check if it is a valid input.
max_length	Defaulted to NA. Pass in to check if it is a valid input.
num_digits	Defaulted to NA. Pass in to check if it is a valid input.
N	Defaulted to NA. Pass in to check if it is a valid input.
standard_df	Defaulted to NA. Pass in to check if it is a valid input.
rounding_patterns	Defaulted to NA. Pass in to check if it is a valid input.
suppress_low_N	Defaulted to NA. Pass in to check if it is a valid input.
suppress_first_division_plots	Defaulted to NA. Pass in to check if it is a valid input.
suppress_second_division_plots	Defaulted to NA. Pass in to check if it is a valid input.
simulate	Defaulted to NA. Pass in to check if it is a valid input.
remove_all_category_visualize	Defaulted to NA. Pass in to check if it is a valid input.

Value

Throw error with message if input is of incorrect type. Returns nothing.

jlederluis/digitanalysis documentation built on Nov. 5, 2023, 11:46 a.m.