Description Usage Arguments Details Value Examples
View source: R/timeBlock.append.R
Appends "block," "block.start," "block.end," and "numBlocks" columns to an input data frame (x) with a dateTime (see dateTime.append) column. This allows users to "block" data into blockLength-blockUnit-long (e.g., 10-min-long) temporal blocks. If x == NULL, the function output will be a data frame with "dateTime" and block-related columns.
1 2 3 4 5 6 7 | timeBlock.append(
x = NULL,
dateTime = NULL,
blockLength = 1,
blockUnit = "hours",
blockingStartTime = NULL
)
|
x |
Data frame containing dateTime information, and to which block information will be appended. if NULL, dateTime input relies solely on the dateTime argument. |
dateTime |
Vector of length nrow(x) or singular character data, detailing the relevant colname in x, that denotes what dateTime information will be used. If argument == NULL, the function assumes a column with the colname "dateTime" exists in x. Defaults to NULL. |
blockLength |
Integer. Describes the number of blockUnits within each temporal block. Defaults to 1. |
blockUnit |
Character string taking the values, "secs," "mins," "hours," "days," or "weeks." Defaults to "hours." |
blockingStartTime |
Character string or date object describing the date OR dateTime starting point of the first time block. For example, if blockingStartTime = "2016-05-01" OR "2016-05-01 00:00:00", the first timeblock would begin at "2016-05-01 00:00:00." If NULL, the blockingStartTime defaults to the minimum dateTime point in x. Note: any blockingStartTime MUST precede or be equivalent to the minimum timepoint in x. Additional note: If blockingStartTime is a character string, it must be in the format ymd OR ymd hms. |
This is a sub-function that can be found in the contactDur functions.
Appends the following columns to x
.
block |
Integer ID describing unique blocks of time of pre-specified length. |
block.start |
The timepoint in |
block.end |
The timepoint in |
numBlocks |
Integer describing the total number of time blocks
observed within |
1 2 3 4 5 6 7 | data("calves")
calves.dateTime<-datetime.append(calves, date = calves$date,
time = calves$time) #add dateTime identifiers for location fixes.
calves.block<-timeBlock.append(x = calves.dateTime,
dateTime = calves.dateTime$dateTime, blockLength = 10,
blockUnit = "mins")
head(calves.block) #see that block information has been appended.
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.