Data Types

Algebraic data types for statistical analyses

v_binary() bnry() is_binary() as_binary() as.character(<v_binary>) as_canonical(<v_binary>)

Binary vectors

v_continuous() cont() is_continuous() as_continuous() as.character(<v_continuous>) as_canonical(<v_continuous>)

Continuous vectors

v_continuous_nonneg() nneg() is_continuous_nonneg() is_nonneg() as_nonneg_continuous() as_continuous_nonneg() as_canonical(<v_continuous_nonneg>)

Non-negative continuous vectors

v_count() cnt() is_count() as_count() as.character(<v_count>) as_canonical()

Count vectors

v_nominal() nom() is_nominal() as_nominal() as_canonical(<v_nominal>)

Nominal categorical vectors

v_ordered() ord() is_ordered() as_ordered() as_canonical(<v_ordered>)

Ordered categorical vectors

v_proportion() prop() is_proportion() is_prop() as_proportion() as_canonical(<v_proportion>)

Proportion vectors

v_rcensored() rcen() is_rcensored() as.character(<v_rcensored>) as_canonical(<v_rcensored>)

Right censored vectors

get_time() get_censored() get_censor_reason() get_outcome() get_outcome_reason()

Get elements from v_rcensored

analysis() is_analysis() as_canonical(<tbl_analysis>)

Analysis

is_stype()

Check that an object is a stype vector

Contexts

Analysis-specific contextual information for styped vectors

describe()

Derive Variable Statistics

context

stype contexts

purpose-class

Purpose object

Data summary

Automatically generated summary information about styped vectors

data_summary-class

A Class Subclassing From the methods::namedList Class

get_data_summary()

Get the summary from a stype variable

stype_df_l() binary_l continuous_l continuous_nonneg_l count_l nominal_l ordered_l proportion_l rcensored_l covariate_l censoring_l competing_l exposure_l identifier_l index_l intermediate_l other_l outcome_l weight_l constant_l not_constant_l tagged_l not_tagged_l tag_l() any_tags_l() all_tags_l() only_tags_l() data_summary_l auto_compute_summary_l extra_descriptors_l vec_data_l context_l internal_name_l extra_descriptors_l derivation_l short_label_l long_label_l description_l security_type_l purpose_l study_role_l tags_l

Lenses for stype vectors

Utilities

get_context() get_short_label() get_long_label() get_description() get_derivation() get_purpose() get_security_type() set_context() set_short_label() set_long_label() set_description() set_derivation() set_purpose() set_security_type()

Get an object's context or elements thereof

get_data_summaries()

Get data summaries from a list of stypes

get_data_summary()

Get the summary from a stype variable

get_internal_name()

Get the internal name from a stype variable

get_time() get_censored() get_censor_reason() get_outcome() get_outcome_reason()

Get elements from v_rcensored

is_study_role

Check a study role

stype_df_l() binary_l continuous_l continuous_nonneg_l count_l nominal_l ordered_l proportion_l rcensored_l covariate_l censoring_l competing_l exposure_l identifier_l index_l intermediate_l other_l outcome_l weight_l constant_l not_constant_l tagged_l not_tagged_l tag_l() any_tags_l() all_tags_l() only_tags_l() data_summary_l auto_compute_summary_l extra_descriptors_l vec_data_l context_l internal_name_l extra_descriptors_l derivation_l short_label_l long_label_l description_l security_type_l purpose_l study_role_l tags_l

Lenses for stype vectors

weight()

Change Weights for stype Vector Elements

pmin_v_rcensored()

Combine Right-Censored Events

as_Surv()

Cast a v_rcensored Type to a Surv Object

is_constant() is_not_constant() is_tagged() is_not_tagged() has_tag() has_any_tags() has_all_tags() has_only_tags()

Useful stype predicates

analysis() is_analysis() as_canonical(<tbl_analysis>)

Analysis

v_binary() bnry() is_binary() as_binary() as.character(<v_binary>) as_canonical(<v_binary>)

Binary vectors

v_continuous() cont() is_continuous() as_continuous() as.character(<v_continuous>) as_canonical(<v_continuous>)

Continuous vectors

v_continuous_nonneg() nneg() is_continuous_nonneg() is_nonneg() as_nonneg_continuous() as_continuous_nonneg() as_canonical(<v_continuous_nonneg>)

Non-negative continuous vectors

v_count() cnt() is_count() as_count() as.character(<v_count>) as_canonical()

Count vectors

v_nominal() nom() is_nominal() as_nominal() as_canonical(<v_nominal>)

Nominal categorical vectors

v_ordered() ord() is_ordered() as_ordered() as_canonical(<v_ordered>)

Ordered categorical vectors

v_proportion() prop() is_proportion() is_prop() as_proportion() as_canonical(<v_proportion>)

Proportion vectors

v_rcensored() rcen() is_rcensored() as.character(<v_rcensored>) as_canonical(<v_rcensored>)

Right censored vectors