Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add input validation for setter and read functions #231

Merged
merged 10 commits into from
Jan 18, 2023
Merged

Add input validation for setter and read functions #231

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d1d9a03
Add function 'verify.data.frame.columns'
maxloeffler Dec 24, 2022
b7a9588
Add dataframe structure verification
maxloeffler Dec 24, 2022
ecfa643
Fix problems that arise due to the structural verification of dataframes
maxloeffler Jan 4, 2023
8043e90
Add copyright header
maxloeffler Jan 4, 2023
de7de7a
Validate custom event timestamps and clarify unclear comments
maxloeffler Jan 13, 2023
1b2e11a
Simplify stuctural checks on custom event timestamps and break long line
maxloeffler Jan 18, 2023
4ff6b53
Update 'NEWS.md'
maxloeffler Jan 18, 2023
1f10f8f
Fix indentation
maxloeffler Jan 18, 2023
fc52984
Change issue number to pull-request number in
maxloeffler Jan 18, 2023
38c2077
Replace experimental 'testthat' feature
maxloeffler Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion util-misc.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,8 @@ verify.data.frame.columns = function(data, columns, data.types = NULL) {
## therefore if there aren't as many datatypes provided in \code{data.types} as column names have
## been provided in \code{columns} we can stop here already
if (!is.null(data.types) && length(columns) != length(data.types)) {
error.message = sprintf("If specified, the length of the two given vectors 'columns' and 'data.types' must match.")
error.message = sprintf(paste("If specified, the length of the two given vectors",
"'columns' and 'data.types' must match."))
bockthom marked this conversation as resolved.
Show resolved Hide resolved
logging::logerror(error.message)
stop(error.message)
}
Expand Down
23 changes: 7 additions & 16 deletions util-read.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -918,28 +918,19 @@ read.custom.event.timestamps = function(data.path, file.name) {
timestamps = as.list(custom.event.timestamps.table[[2]])
names(timestamps) = custom.event.timestamps.table[[1]]

## check if first column of input has type character
if (class(names(timestamps)) != "character") {
error.message = sprintf(
"The first column of custom event timestamps should be of type character but is '%s'",
class(names(timestamps)))
## convert all timestamps to POSIXct format
posix.timestamps = get.date.from.string(timestamps)

## if a timestamp is malformatted get.date.from.string returns a NA
if (any(is.na(posix.timestamps))) {
error.message = sprintf("Input timestamps are not in POSIXct format (YYYY-mm-DD HH:MM:SS).")
logging::logerror(error.message)
stop(error.message)
}

## check if second column of input is in POSIXct format by converting
## all elements to POSIXct and catch possible errors
tryCatch(sapply(timestamps, function(time) as.POSIXct(time)),
error = function(e) {
error.message = sprintf("The second column of custom event timestamps should be in POSIXct format")
logging::logerror(error.message)
stop(error.message)
})


## Sort the timestamps
if (length(timestamps) != 0) {
timestamps = timestamps[order(unlist(get.date.from.string(timestamps)))]
timestamps = timestamps[order(unlist(posix.timestamps))]
}

logging::logdebug("read.custom.event.timestamps: finished.")
Expand Down