Package 'eider'

Title: Declarative Feature Extraction from Tabular Data Records
Description: Extract features from tabular data in a declarative fashion, with a focus on processing medical records. Features are specified as JSON and are independently processed before being joined. Input data can be provided as CSV files or as data frames. This setup ensures that data is transformed in a modular and reproducible manner, and allows the same pipeline to be easily applied to new data.
Authors: Catalina Vallejos [ctb] , Louis Aslett [ctb] , Simon Rogers [ctb] , Camila Rangel Smith [cre, ctb] , Helen Duncan Little [aut] , Jonathan Yong [aut] , The Alan Turing Institute [cph, fnd]
Maintainer: Camila Rangel Smith <[email protected]>
License: MIT + file LICENSE
Version: 1.0.0
Built: 2024-12-10 04:43:31 UTC
Source: https://github.com/alan-turing-institute/eider

Help Index

Obtain filepaths to example data and JSON features

Description

Return an absolute path to the example data and JSON features provided with the package. These files are contained in the package inst/extdata directory.

Usage

eider_example(file = NULL)

Arguments

file

The filename to return the full path for. Defaults to NULL, in which case it will return a vector of all valid filenames.

Value

A string containing the full path to the file, or a vector of filenames

Examples

eider_example()
eider_example("random_ae_data.csv")

Perform the entire feature transformation process

Description

Reads in data and feature specifications and performs the requisite transformations. Please see the package vignettes for more detailed information on the JSON specification of features.

Usage

run_pipeline(
  data_sources,
  feature_filenames = NULL,
  response_filenames = NULL,
  all_ids = NULL
)

Arguments

data_sources

A list, whose names are the unique identifiers of the data sources, and whose values are either the data frame itself or the file path from which they should be read from. Only CSV files are supported at this point in time.
feature_filenames

A vector of file paths to the feature JSON specifications. Defaults to NULL.
response_filenames

A vector of file paths to the response JSON specifications. Defaults to NULL.
all_ids

A vector of all the unique numeric identifiers that should be in the final feature table. If not given, this will be determined by taking the union of all unique identifiers found in input tables used by at least one feature.

Value

A list with the following elementss:

  • features: A data frame with all the features. The first column is the ID column, and always has the name id. Subsequent columns are the features, with column names as specified in the output_feature_name field of the JSON files.

  • responses: A data frame with all the responses. The structure is the same as the features data frame.

Examples

run_pipeline(
  data_sources = list(ae = eider_example("random_ae_data.csv")),
  feature_filenames = eider_example("ae_total_attendances.json")
)