trinetx.profile_table API documentation

Function `profile_table`

def profile_table(database=None, tables=None)

Description

The profile_table function leverages the Python DataPrep package (https://pypi.org/project/dataprep/) to generate a summary report for any table in a dataset database.

Inputs

database - dataset database name to use
tables - names of tables in the dataset to use that is a list

Returns

Returns the create_report function of DataPrep package for all fields in the dataset tables passed in the input
- display only Overview and Variable section
name of the report is name of the database “.” table name (lucid_db.diagnosis)

Example

profile_table(database='database', tables=['diagnosis','procedure'])