readDataSIUS: Read data files exported by the SIUS e-target system

View source: R/readData.R

readDataSIUSR Documentation

Read data files exported by the SIUS e-target system

Description

Reads in data from files exported by the SIUS e-target system using semi-colon separated text files without headers. Several files can be read with one call.

Usage

readDataSIUS(fPath = ".", fNames, fPat, combine = TRUE)

Arguments

fPath

a character string containing the path to the folder with the SIUS output files, e.g. 'c:/folder/siusFiles'.

fNames

a character vector containing the file names of the files that should be read in.

fPat

a character string containing the regular-expression that describes all names of files that should be read in. E.g., '^points[[:digit:]]{2}\\.txt$' for filenames 'points**.txt', where ** are 2 digits. See regex, glob2rx.

combine

logical: combine the data into one big data frame with combineData?

Details

If fNames is provided, fPat is ignored.

If neither fNames nor fPat is provided, and we are in interactive mode under Windows, files can be chosen interactively.

Output files can be semi-colon separated files (file type .csv) from SIUS e-target.

Value

With combine=FALSE: a list of data frames, each from one file that was read in. This list can then be combined into one big data frame by combineData.

file1

data frame containing data from the first file

file2

data frame containing data from the second file

...

more data frames

With combine=TRUE: a combined data frame from combineData.

See Also

read.csv, regex, glob2rx, combineData, readDataOT1, readDataOT2, readDataSMT, readDataShotMarker, readDataMisc

Examples

## Not run: 
# folder with SIUS e-target output files
fPath   <- 'c:/folder/siusFiles'
fileNam <- c('pts01.csv', 'pts02.csv')    # desired files in that folder
DFgroup <- readDataSIUS(fPath, fNames=fileNam, combine=TRUE)

## alternatively, specify filename pattern for all files to be read in
fPath   <- 'c:/folder/siusFiles'          # folder with data files
fPat    <- '^pts[[:digit:]]{2}\\.csv$'  # filename pattern
DFgroup <- readDataSIUS(fPath, fPat=pattern, combine=TRUE)

## End(Not run)

## result should look like this
data(DFcm)
head(DFcm)

dwoll/shotGroups documentation built on Feb. 16, 2024, 2:21 p.m.