ovdata_example_roster: Example volleyball team roster files

View source: R/example-roster.R

ovdata_example_rosterR Documentation

Example volleyball team roster files

Description

Example volleyball team roster files

Usage

ovdata_example_roster(
  choice = "Stadium Mirandola",
  as = "path",
  simplify = TRUE
)

Arguments

choice

string: one or more files to return

as

string: either "path" (return the path to the file) or "parsed" (parse the file into an R data structure using datavolley::dv_read_sq()

simplify

logical: by default if as is "parsed", the returned list is the same length as choice where each entry is a parsed object. If simplify is TRUE and we have asked for a single file (i.e. length(choice) == 1, then return just that object (not a list containing that object)

Value

If as is "path", a character vector with the file path(s), otherwise a list

See Also

ovdata_example()

Examples

myfile <- ovdata_example_roster()
## read this file with
## x <- datavolley::dv_read_sq(myfile)

## or have it read automatically
x <- ovdata_example_roster(as = "parsed")


openvolley/ovdata documentation built on March 25, 2023, 6:18 p.m.