_pkgdown.yml

url: https://poissonconsulting.github.io/chk/
template:
  bootstrap: 5
  package: poissontemplate

reference:
- title: Missing Input Checkers
  desc: Check if the function input is missing or not
  contents:
  - chk_missing
  - chk_not_missing
- title: ... Checkers
  desc: Check if the function input comes from ... (dot-dot-dot) or not
  contents:
  - chk_used
  - chk_unused
- title: External Data Source Checkers
  desc: Check if the function input is a valid external data source
  contents:
  - chk_file
  - chk_ext
  - chk_dir
- title: NULL Checkers
  desc: Check if the function input is NULL or not or something else
  contents:
  - chk_null
  - chk_not_null
  - chk_null_or
- title: Data Structure Checkers
  desc: Check if the function input has a specific data structure
  contents:
  - chk_vector
  - chk_atomic
  - chk_array
  - chk_matrix
  - chk_list
  - chk_data
- title: Data Type Checkers
  desc: Check if the function input has a data type
  contents:
  - chk_environment
  - chk_logical
  - chk_character
  - chk_numeric
  - chk_double
  - chk_integer
- title: Whole Number Checkers
  desc: Check if the function input is a whole number, whether explicitly an integer or a double type without fractional parts
  contents:
  - chk_whole_numeric
  - chk_whole_number
  - chk_count
- title: Factor Checker
  desc: Check if the function input is a factor
  contents:
  - chk_factor
  - chk_character_or_factor
- title: Scalar Checkers
  desc: Check if the function input is a vector of length 1
  contents:
  - chk_scalar
  - chk_string
  - chk_number
  - chk_flag
  - chk_lgl
  - chk_true
  - chk_false
- title: Date or DateTime Checkers
  desc: Check if the function input is of class Date or DateTime
  contents:
  - chk_date
  - chk_date_time
- title: Time Zone Checker
  desc: Check if the function input is a Time Zone
  contents:
  - chk_tz
- title: All Elements Checker
  desc: Check if the function input has a characteristic shared by all its elements
  contents:
  - chk_all
- title: Function Checker
  desc: Check if the function input is another function
  contents:
  - chk_function
- title: Names Checkers
  desc: Check if the function input has names and are valid
  contents:
  - chk_named
  - chk_valid_name
- title: Range Checkers
  desc: Check if the function input is part of a range of values
  contents:
  - chk_range
  - chk_lt
  - chk_lte
  - chk_gt
  - chk_gte
- title: Equal Checkers
  desc: Check if the function input is equal or similar to a predefined object
  contents:
  - chk_identical
  - chk_equal
  - chk_equivalent
  - chk_all_identical
  - chk_all_equal
  - chk_all_equivalent
- title: Order Checker
  desc: Check if the function input are numbers in increasing order
  contents:
  - chk_sorted
- title: Set Checkers
  desc: Check if the function input is composed by certain elements
  contents:
  - chk_subset
  - chk_not_subset
  - chk_superset
  - chk_setequal
  - chk_orderset
- title: Identity Checkers
  desc: Check if the function input belongs to a class
  contents:
  - chk_is
  - chk_s3_class
  - chk_s4_class
- title: REGEX Checker
  desc: Check if the function input matches a REGEX
  contents:
  - chk_match
- title: Length Checkers
  desc: Check if the function input object's length is a specific value or if because of its length can be strictly recycled
  contents:
  - chk_length
  - chk_compatible_lengths
- title: Quality Checkers (Miscellaneous)
  desc: Check if the function input meet some user defined quality criteria
  contents:
  - chk_not_any_na
  - chk_not_empty
  - chk_sorted
  - chk_unique
  - chk_join
  - chkor_vld
- title: chk_ Function Extenders
  desc: Extending chk_ functions
  contents:
  - backtick_chk
  - unbacktick_chk
  - deparse_backtick_chk
  - message_chk
  - abort_chk
  - expect_chk_error
- title: Message Generators
  desc: Generating messages
  contents:
  - err
  - wrn
  - msg
- title: String Manipulators
  desc: Manipulating strings
  contents:
  - p
  - p0
  - cc
- title: check_ Functions
  desc: Checks more properties about the objects
  contents:
  - check_data
  - check_dim
  - check_dirs
  - check_files
  - check_key
  - check_names
  - check_values
- title: Deprecated Functions
  desc: Functions that have been deprecated
  contents:
  - chk_chr
  - chk_dbl
  - chk_wnum
  - chkor


development:
  mode: auto