Skip to content

Add filter logic to export_records #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sburns merged 5 commits into from
Oct 12, 2018
Merged

Add filter logic to export_records #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a2562b8
add filter logic to export_records
erikh360 Sep 21, 2018
656e7f5
change tests to used mocked endpoints
erikh360 Oct 4, 2018
86e0130
update requirements file
erikh360 Oct 4, 2018
60c00e3
fixed pandas tests
erikh360 Oct 5, 2018
10414aa
clean tests
erikh360 Oct 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,6 @@ docs/_build/
_site/
.idea/
*.swp
.vscode/
ve/
.noseids
7 changes: 6 additions & 1 deletion redcap/project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ def export_records(self, records=None, fields=None, forms=None,
events=None, raw_or_label='raw', event_name='label',
format='json', export_survey_fields=False,
export_data_access_groups=False, df_kwargs=None,
export_checkbox_labels=False):
export_checkbox_labels=False, filter_logic=None):
"""
Export data from the REDCap project.

Expand Down Expand Up @@ -289,6 +289,8 @@ def export_records(self, records=None, fields=None, forms=None,
export_checkbox_labels : (``False``), ``True``
specify whether to export checkbox values as their label on
export.
filter_logic : string
specify the filterLogic to be sent to the API.

Returns
-------
Expand All @@ -314,6 +316,9 @@ def export_records(self, records=None, fields=None, forms=None,
pl[key] = ','.join(data)
else:
pl[key] = data

if filter_logic:
pl["filterLogic"] = filter_logic
response, _ = self._call_api(pl, 'exp_record')
if format in ('json', 'csv', 'xml'):
return response
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ numpydoc==0.4
semantic-version==2.3.1
requests>=1.1.0
wheel==0.22.0
responses==0.9.0
Loading