datakiln.build_redcap module¶
Builds table metadata from redcap api
- datakiln.build_redcap.get_id(project)[source]¶
Get subject ID and REDCAP event fields.
- Parameters:
project (redcap.Project) – PyCap project.
- Returns:
Subject ID and Event ID columns metadata.
- Return type:
dict
- datakiln.build_redcap.get_metadata(project)[source]¶
Get metadata for project forms.
- Parameters:
project (redcap.Project) – PyCap project.
- Returns:
Forms metatada.
- Return type:
pandas.DataFrame
- datakiln.build_redcap.get_postgres_type(field_type, validation)[source]¶
Define PostgreSQL column types from redcap metadata.
- Parameters:
c_type (type) – Python type.
- Returns:
PostgreSQL data type.
- Return type:
str
- datakiln.build_redcap.generate_column_meta(field_name, field_meta)[source]¶
Generate column metadata from redcap.
- Parameters:
field_name (str) – Name of the redcap form field.
field_meta (pandas.DataFrame) – PyCap metadata record.
- Returns:
Column metatada.
- Return type:
dict
- datakiln.build_redcap.generate_table_meta(form_name, form_meta, is_data_empty, subject_id, event_id, primary_key='meta_row_id', schema_name='', encoding='utf-8')[source]¶
Generate table metadata from redcap.
- Parameters:
form_name (bool) – Name of the redcap form.
form_meta (pandas.DataFrame) – PyCap metadata records.
is_data_empty – Flag identifying if data contain relevant fields.
primary_key – Primary key for the table.
schema_name (str) – Name of the schema in PostgreSQL db.
encoding (str) – Encoding type
- Returns:
Table metadata.
- Return type:
dict
- datakiln.build_redcap.generate_table_data(project, form_name, form_meta, subject_id, event_id, na_values=None)[source]¶
Retrieve table data from redcap.
- Parameters:
project (redcap.Project) – PyCap project.
form_name (str) – Name of the redcap form.
form_meta (pandas.DataFrame) – PyCap metadata records.
- Returns:
Table data.
- Return type:
pandas.DataFrame