splash_clean_strings: Cleans input strings

In SwimmeR: Data Import, Cleaning, and Conversions for Swimming Results

Cleans input strings

Description

Cleans input from read_results is passed to splash_swim_parse to remove unnneded characters and otherwise set it up for sorting. Input is in the form of character strings

Usage

splash_clean_strings(
  x,
  indent_length = Indent_Length,
  time_score_string = Time_Score_String,
  record_string = Record_String,
  header_string = Header_String,
  sponsorship_string = Sponsorship_String,
  reaction_string = Reaction_String,
  rule_string = Rule_String
)

Arguments

x	a list of character strings
indent_length	a numeric value denoting the number of spaces some results are indented by. indent_length is determined by splash_determine_indent_length. Must be a whole number.
time_score_string	a regex string for matching results (times and scores) but not special strings like DQ
record_string	a regex string for matching denoted records, rather than results
header_string	a regex string from matching splash headers/footers included in result documents
sponsorship_string	a regex string for matching sponsorship text within result documents
reaction_string	a regex string for matching reaction times
rule_string	a regex string for matching rule text e.g. 'Rule 4.24' that sometimes accompanies DQs

Value

returns a list of character strings that have been cleaned in preparation for parsing/sorting

#' @seealso splash_clean_strings runs inside of swim_parse_splash

SwimmeR documentation built on March 31, 2023, 8:27 p.m.