inst/tinytest/test_formatFields.R

In steffenoppel/track2iba: Identifying Important Areas from Animal Tracking Data

library(track2KBA)
library(lubridate)

dat <- data.frame(x = rep(1:10, 2), y = rep(1:10, 2),
                  id = c(rep("A", 10), rep("B", 10)),
                  dt = format(ymd_hms("2021-01-01 00:00:00") + hours(0:9))
                  )

expect_error(formatFields("dat"), pattern = "Object")

## test that misspecified column names gives error 
expect_error(formatFields(dat, 
                          fieldID = "id",
                          fieldDateTime = "t",
                          fieldLat = "y",
                          fieldLon = "x"))
expect_error(formatFields(dat, 
                          fieldID = "ids"), pattern = "fieldID supplied")
expect_error(formatFields(dat, fieldID = "id",
                          fieldLat = "lats"), pattern = "fieldLat supplied")
expect_error(formatFields(dat, fieldID = "id", fieldLat = "y",
                          fieldLon = "lons"), pattern = "fieldLon supplied")

expect_message(formatFields(dat, 
                          fieldID = "id",
                          fieldDateTime = "dt",
                          fieldDate = "dt",
                          fieldTime = "dt",
                          fieldLat = "y",
                          fieldLon = "x"), pattern = "Both a DateTime")

## test that 'cleanDF' option works ## 
expect_true(!"dt" %in% colnames(formatFields(dat,
                                             fieldID = "id",
                                             fieldDateTime = "dt",
                                             fieldLat = "y",
                                             fieldLon = "x",
                                             formatDT = "ymd HMS",
                                             cleanDF = TRUE)
                                ) )
expect_false(!"dt" %in% colnames(formatFields(dat,
                                             fieldID = "id",
                                             fieldDateTime = "dt",
                                             fieldLat = "y",
                                             fieldLon = "x",
                                             formatDT = "ymd HMS",
                                             cleanDF = FALSE)
) )


## Test that non-specification of an "ID" column which exists in the dataset 
# still works 
dat$ID <- dat$id

expect_true( "ID" %in% colnames(formatFields(dat,
                                             fieldDateTime = "dt",
                                             fieldLat = "y",
                                             fieldLon = "x",
                                             formatDT = "ymd HMS")) 
) 

## BirdLife STD standard format ##
dat2 <- data.frame(longitude = rep(1:10, 2), latitude = rep(1:10, 2),
                  track_id = c(rep("A", 10), rep("B", 10)),
                  date_gmt = rep("2021-01-01"),
                  time_gmt = do.call(rbind, strsplit(dat$dt, split=" "))[,2]
)

## test that 'formatBL' option works ## 
expect_error( formatFields(dat2,
                          formatBL = TRUE) )       
expect_true( "DateTime" %in% colnames(formatFields(dat2,
                                             formatBL = TRUE,
                                             fieldID = "track_id")) )
expect_true( "ID" %in% colnames(formatFields(dat2,
                                             formatBL = TRUE,
                                             fieldID = "track_id"
                                             )) ) 
expect_true( "Latitude" %in% colnames(formatFields(dat2,
                                                   formatBL = TRUE,
                                                   fieldID = "track_id"
                                                   )) ) 
expect_true( "Longitude" %in% colnames(formatFields(dat2,
                                                    formatBL = TRUE,
                                                    fieldID = "track_id"
                                                    )) ) 
expect_true( "POSIXct" %in% class(formatFields(dat2, 
                                               formatBL = TRUE,
                                               fieldID = "track_id")$DateTime) )

## Test that dual-specification of an "ID" column which exists in the dataset 
# still works 
dat2$ID <- dat2$track_id

expect_true( "ID" %in% colnames(formatFields(dat2,
                                             fieldID = "track_id",
                                             formatBL = T)) 
) 

expect_true( "ID" %in% colnames(formatFields(dat2,
                                             fieldID = "track_id",
                                             formatBL = T,
                                             cleanDF = T)) 
) 

## separate date and time columns 
dat2 <- data.frame(x = rep(1:10, 2), y = rep(1:10, 2),
                  id = c(rep("A", 10), rep("B", 10)),
                  dt = format(ymd_hms("2021-01-01 00:00:00") + hours(0:9))
)

dat2$date <- do.call(rbind, strsplit(dat2$dt, split=" ", fixed=TRUE))[,1]
dat2$time <- do.call(rbind, strsplit(dat2$dt, split=" ", fixed=TRUE))[,2]

expect_silent(formatFields(dat2, 
                           fieldID = "id",
                           fieldDate = "date",
                           fieldTime = "time",
                           fieldLat = "y",
                           fieldLon = "x") 
)
expect_silent(formatFields(dat2, 
                           fieldID = "id",
                           fieldDate = "date", fieldTime = "time",
                           fieldLat = "y", fieldLon = "x",
                           formatDT = "ymd HMS"), 
)

## only date column
expect_silent(formatFields(dat2, 
                           fieldID = "id",
                           fieldDate = "date",
                           fieldLat = "y",
                           fieldLon = "x") 
)
expect_silent(formatFields(dat2, 
                           fieldID = "id",
                           fieldDate = "date",
                           fieldLat = "y", fieldLon = "x",
                           formatDT = "ymd"), 
)
dat$dt <- as.POSIXct(dat$dt)
expect_silent(formatFields(dat, 
                            fieldID = "id",
                            fieldDateTime = "dt",
                            fieldLat = "y",
                            fieldLon = "x") 
              )