jubilee2 / RedcapLite

A Lightweight Python Client for REDCap

redcaplite

redcaplite is a Python package for interacting with the REDCap API. This package provides methods to interact with different API endpoints in a straightforward way.

Installation

To install the package, clone the repository and install it using pip:

pip install redcaplite

Usage

Importing the Package

To use the redcaplite package, import it in your Python script:

import redcaplite

Creating an Instance

Create an instance of the RedcapClient class by providing the API URL and token:

r = redcaplite.RedcapClient('https://redcap.vumc.org/api/', 'your_token')

Methods

API Name	Export	Import	Delete
Arms	get_arms()	import_arms()	delete_arms()
DAGs	get_dags()	import_dags()	delete_dags()
User DAG Mapping	get_user_dag_mappings()	import_user_dag_mappings()
Events	get_events()	import_events()	delete_events()
Field Names	get_field_names()
File	get_file()	import_file()	delete_file()
File Repository (File)	export_file_repository()	import_file_repository()	delete_file_repository()
File Repository (Folder)	list_file_repository()	create_folder_file_repository()
Instrument	get_instruments()
Instrument (PDF)	export_pdf()
Form Event Mapping	get_form_event_mappings()	import_form_event_mappings()
Log	get_logs()
Metadata	get_metadata()	import_metadata()
Project	get_project() get_project_xml()	import_project_settings()
Project (super user)		create_project()
Record	export_records() generate_next_record_name()	import_records() rename_record()	delete_records()
Repeating Forms Events	get_repeating_forms_events()	import_repeating_forms_events()
Report	get_report()
Version	get_version()
Survey	get_survey_link() get_survey_queue_link() get_survey_return_code() get_participant_list()
Users	get_users()	import_users()	delete_users()
User Role	get_user_roles()	import_user_roles()	delete_user_roles()
User Role Mapping	get_user_role_mappings()	import_user_role_mappings()

Example

Here’s a complete example of how to use the redcaplite package:

import redcaplite

# Create an instance of RedcapClient
r = redcaplite.RedcapClient('https://redcap.vumc.org/api/', 'your_token')

# Get arms
arms = r.get_arms()
print("Arms:", arms)

# Delete specific arms
r.delete_arms(arms=[3])
print("Arm 3 deleted successfully.")

Improved CSV Export with pd_read_csv_kwargs

We've added a new feature to our export_records and get_report methods to give you more control over the CSV export process. With the pd_read_csv_kwargs parameter, you can now specify additional keyword arguments to pass to pandas.read_csv, allowing you to customize the data types of your exported data.

Handling Data Types with dtype

One common use case for pd_read_csv_kwargs is to specify the data type of specific columns in your exported data. For example, you may want to ensure that a column like participant_study_id is exported as a string, rather than being automatically converted to a numeric type. Here's an example of how you can use pd_read_csv_kwargs to achieve this:

export_records(pd_read_csv_kwargs={'dtype':{'participant_study_id': str}})

In this example, we're passing a dictionary to pd_read_csv_kwargs with a single key-value pair: dtype. The value of dtype is another dictionary that specifies the data type for the participant_study_id column. By setting this to str, we ensure that the values in this column are exported as strings, rather than being converted to a numeric type.

Benefits of using pd_read_csv_kwargs

By using pd_read_csv_kwargs to customize the CSV export process, you can:

• Ensure that sensitive data, like participant IDs, are exported in a format that preserves their original data type
• Avoid issues with automatic data type conversion, which can lead to errors or unexpected behavior downstream
• Take advantage of pandas' robust data type handling capabilities to fine-tune your exported data

We hope this new feature helps you to work more efficiently and effectively with your REDCap data!

Contributing

If you would like to contribute to the project, please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.