neurobooth_terra.redcap.fetch_survey

neurobooth_terra.redcap.fetch_survey(project, survey_name, survey_id, index=None, cast_dtype=True)[source]

Get schema of table from redcap

Parameters
projectinstance of Project

The project created using pycap.

survey_namestr

The name of the survey to export

survey_idint

The survey_id. See under Reports in Redap.

indexstr

The column to set as index.

cast_dtypebool

If True, cast to datatype. This is done by writing the dataframe to a temporary csv file and reading it back.

Returns
dfinstance of DataFrame

The pandas dataframe.