Package 'SensusR'

Title: Sensus Analytics
Description: Provides access and analytic functions for Sensus data.
Authors: Matthew S. Gerber
Maintainer: Matthew S. Gerber <[email protected]>
License: GPL-3
Version: 2.3.1
Built: 2024-11-22 03:51:43 UTC
Source: https://github.com/cran/SensusR

Help Index

Plot accelerometer data.

Description

Plot accelerometer data.

Usage

## S3 method for class 'AccelerometerDatum'
plot(x, pch = ".", type = "l", ...)

Arguments

x

Accelerometer data.
pch

Plotting character.
type

Line type.
...

Other plotting parameters.

Value

None

Plot altitude data.

Description

Plot altitude data.

Usage

## S3 method for class 'AltitudeDatum'
plot(x, pch = ".", type = "l", ...)

Arguments

x

Altitude data.
pch

Plotting character.
type

Line type.
...

Other plotting parameters.

Value

None

Plot battery data.

Description

Plot battery data.

Usage

## S3 method for class 'BatteryDatum'
plot(x, pch = ".", type = "l",
  main = "Battery", ...)

Arguments

x

Battery data.
pch

Plotting character.
type

Line type.
main

Main title.
...

Other plotting parameters.

Value

None

Plot cell tower data.

Description

Plot cell tower data.

Usage

## S3 method for class 'CellTowerDatum'
plot(x, ...)

Arguments

x

Cell tower data.
...

Other plotting arguments.

Value

None

Plot compass data.

Description

Plot compass data.

Usage

## S3 method for class 'CompassDatum'
plot(x, pch = ".", type = "l", ...)

Arguments

x

Compass data.
pch

Plotting character.
type

Line type.
...

Other plotting parameters.

Value

None

Plot light data.

Description

Plot light data.

Usage

## S3 method for class 'LightDatum'
plot(x, pch = ".", type = "l", ...)

Arguments

x

Light data.
pch

Plotting character.
type

Line type.
...

Other plotting parameters.

Value

None

Plot location data.

Description

Plot location data.

Usage

## S3 method for class 'LocationDatum'
plot(x, ...)

Arguments

x

Location data.
...

Arguments to pass to plotting routines. This can include two special arguments: qmap.args (passed to qmap) and geom.point.args (passed to geom_point).

Value

None

Plot screen data.

Description

Plot screen data.

Usage

## S3 method for class 'ScreenDatum'
plot(x, ...)

Arguments

x

Screen data.
...

Other plotting parameters.

Value

None

Plot sound data.

Description

Plot sound data.

Usage

## S3 method for class 'SoundDatum'
plot(x, pch = ".", type = "l", ...)

Arguments

x

Sound data.
pch

Plotting character.
type

Line type.
...

Other plotting parameters.

Value

None

Plot speed data.

Description

Plot speed data.

Usage

## S3 method for class 'SpeedDatum'
plot(x, pch = ".", type = "l", ...)

Arguments

x

Speed data.
pch

Plotting character.
type

Line type.
...

Other plotting parameters.

Value

None

Plot telephony data.

Description

Plot telephony data.

Usage

## S3 method for class 'TelephonyDatum'
plot(x, ...)

Arguments

x

Telephony data.
...

Other plotting parameters.

Value

None

Plot WLAN data.

Description

Plot WLAN data.

Usage

## S3 method for class 'WlanDatum'
plot(x, ...)

Arguments

x

WLAN data.
...

Other plotting parameters.

Value

None

Decompresses JSON files downloaded from AWS S3.

Description

Decompresses JSON files downloaded from AWS S3.

Usage

sensus.decompress.gz.files(local.path, skip = TRUE, overwrite = FALSE,
  remove = FALSE)

Arguments

local.path

Path to location on local machine.
skip

If TRUE and the output file already exists, the output file is returned as is.
overwrite

If TRUE and the output file already exists, the file is silently overwritten; otherwise an exception is thrown (unless skip is TRUE).
remove

If TRUE, the input file is removed afterward, otherwise not.

Value

None

Decrypts Sensus .bin files that were encrypted using asymmetric public/private key encryption.

Description

Decrypts Sensus .bin files that were encrypted using asymmetric public/private key encryption.

Usage

sensus.decrypt.bin.files(data.path, is.directory = TRUE,
  recursive = TRUE, rsa.private.key.path,
  rsa.private.key.password = askpass, replace.files = FALSE)

Arguments

data.path

Path to Sensus .bin data (either a file or a directory).
is.directory

Whether or not the path is a directory.
recursive

Whether or not to read files recursively from directory indicated by path.
rsa.private.key.path

Path to RSA private key generated using OpenSSL.
rsa.private.key.password

Password used to decrypt the RSA private key.
replace.files

Whether or not to delete .bin files after they have been decrypted.

Value

None

Get timestamp lags for a Sensus data frame.

Description

Get timestamp lags for a Sensus data frame.

Usage

sensus.get.all.timestamp.lags(data)

Arguments

data

Data to plot lags for (e.g., the result of sensus.read.json.files).

Value

List of lags organized by datum type.

Get timestamp lags for a Sensus datum.

Description

Get timestamp lags for a Sensus datum.

Usage

sensus.get.timestamp.lags(datum)

Arguments

datum

Data to plot lags for (e.g., the result of sensus.read.json.files).

Value

List of lags.

Gets unique device IDs within a dataset.

Description

Gets unique device IDs within a dataset.

Usage

sensus.get.unique.device.ids(data)

Arguments

data

Data to write, as read using sensus.read.json.files.

Value

Unique device IDs within the data.

Lists activities in a given phase and state.

Description

Lists activities in a given phase and state.

Usage

sensus.list.activities(data, phase = "Starting", state = "Active")

Arguments

data

Data, as returned by sensus.read.json.files.
phase

Phase of activity (Starting, During, Stopping)
state

State of phase (Active, Inactive, Unknown)

Value

None

Lists S3 buckets.

Description

Lists S3 buckets.

Usage

sensus.list.aws.s3.buckets(profile = "default",
  aws.path = "/usr/local/bin/aws")

Arguments

profile

AWS credentials profile to use for authentication.
aws.path

Path to AWS client.

Value

None

Plot the CDF of inter-reading time lags.

Description

Plot the CDF of inter-reading time lags.

Usage

sensus.plot.lag.cdf(datum, xlim = c(0, 1),
  xlab = "Inter-reading time (seconds)", ylab = "Percentile",
  main = paste("Inter-reading times (n=", nrow(datum), ")", sep = ""))

Arguments

datum

Data frame for a single datum.
xlim

Limits for the x-axis.
xlab

Label for x-axis.
ylab

Label for y-axis.
main

Label for plot.

Value

None.

Read JSON-formatted Sensus data.

Description

Read JSON-formatted Sensus data.

Usage

sensus.read.json.files(data.path, is.directory = TRUE,
  recursive = TRUE, local.timezone = Sys.timezone(),
  data.types = NULL)

Arguments

data.path

Path to Sensus JSON data (either a file or a directory).
is.directory

Whether or not the path is a directory.
recursive

Whether or not to read files recursively from directory indicated by path.
local.timezone

The local timezone to convert datum timestamps to, or NULL to leave the timestamps unconverted.
data.types

Specific data types to read. A full list of data types can be found here: https://predictive-technology-laboratory.github.io/sensus/api/Sensus.Datum.html. For example c("AccelerometerDatum", "HeightDatum") will only read accelerometer and height data. Pass NULL to read all data types.

Value

All data, listed by type.

Examples

# data.path = system.file("extdata", "example-data", package="SensusR")	
# data = sensus.read.json.files(data.path)

Removes all data associated with a device ID from a data collection.

Description

Removes all data associated with a device ID from a data collection.

Usage

sensus.remove.device.id(datum, device.id)

Arguments

datum

Data collection to process.
device.id

Device ID to remove.

Value

Data without a particular device ID.

Synchronizes data from Amazon S3 to a local path.

Description

Synchronizes data from Amazon S3 to a local path.

Usage

sensus.sync.from.aws.s3(s3.path, profile = "default",
  local.path = tempfile(), aws.path = "/usr/local/bin/aws",
  delete = FALSE, decompress = FALSE)

Arguments

s3.path

Path within S3. This can be a prefix (partial path).
profile

AWS credentials profile to use for authentication.
local.path

Path to location on local machine.
aws.path

Path to AWS client.
delete

Whether or not to delete local files that are not present in the S3 path.
decompress

Whether or not to decompress any gzip files after downloading them.

Value

Local path to location of downloaded data.

Write data to CSV files.

Description

Write data to CSV files.

Usage

sensus.write.csv.files(data, directory, file.name.prefix = "")

Arguments

data

Data to write, as read using sensus.read.json.files.
directory

Directory to write CSV files to. Will be created if it does not exist.
file.name.prefix

Prefix to add to the generated file names.

Value

None

Write data to rdata files.

Description

Write data to rdata files.

Usage

sensus.write.rdata.files(data, directory, file.name.prefix = "")

Arguments

data

Data to write, as read using sensus.read.json.files.
directory

Directory to write CSV files to. Will be created if it does not exist.
file.name.prefix

Prefix to add to the generated file names.

Value

None

SensusR: Sensus Analytics

Description

Provides access and analytic functions for Sensus data. More information can be found at the following URL:

Details

https://predictive-technology-laboratory.github.io/sensus

SensusR functions

The SensusR functions handle reading, cleaning, plotting, and otherwise analyzing data collected via the Sensus system.

Trim leading and trailing white space from a string.

Description

Trim leading and trailing white space from a string.

Usage

trim(x)

Arguments

x

String to trim.

Value

Result of trimming.

Trim leading white space from a string.

Description

Trim leading white space from a string.

Usage

trim.leading(x)

Arguments

x

String to trim.

Value

Result of trimming.

Trim trailing white space from a string.

Description

Trim trailing white space from a string.

Usage

trim.trailing(x)

Arguments

x

String to trim.

Value

Result of trimming.