ox_info: Info on 'ox_all' objects

In acobos/ox: Reads OpenClinica xml export files

Description

Provides asuperficial view of an ox_all object, including minimal information on datapoints, subjects, items, (item) groups, forms and events.

Usage

ox_info(ox_obj, assessments = FALSE)

Arguments

ox_obj	An object of class ox_all, as returned by ox_all().
assessments	logical indicating if assessments (groups by events) should be included in output. Default is FALSE.

Value

A list with the following components:

• numbers: numbers of datapoints, subjects, sites, events, forms, groups, and items, in ox_obj$data.

• events: unique values of event_oid in ox_obj$data.

• forms: unique values of form_oid in ox_obj$data.

• groups: unique values of group_oid in ox_obj$data.

• assessments: when assessments = TRUE. A dataframe showing the number of datapoints (rows in ox_obj$data) per event_oid and group_oid.

Examples

# The example odm1.3 xml file address
my_file <- system.file("extdata",
                       "odm1.3_full_example.xml",
                       package = "ox",
                       mustWork = TRUE)

# Parsing the xml file
library(XML)
doc <- xmlParse(my_file)

# Creating ox object
my_ox_obj <- ox_all(doc)

# Getting summary info (default)
ox_info(my_ox_obj)

# Same, including assessments table
ox_info(my_ox_obj, assessments = TRUE)

acobos/ox documentation built on May 13, 2019, 12:17 p.m.