research.views package¶

Module contents¶

Submodules¶

research.views.group module¶

Definition of the GroupViewSet class.

class research.views.group.GroupViewSet(**kwargs)¶

Bases: pylabber.views.defaults.DefaultsMixin, rest_framework.viewsets.ModelViewSet

API endpoint that allows Group instances to be viewed or edited.

basename = None¶

description = None¶

detail = None¶

filter_class¶: alias of research.filters.group_filter.GroupFilter

get_serializer_class()¶

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

name = None¶

queryset¶

suffix = None¶

research.views.study module¶

Definintion of the StudyViewSet class.

class research.views.study.StudyViewSet(**kwargs)¶

Bases: pylabber.views.defaults.DefaultsMixin, rest_framework.viewsets.ModelViewSet

API endpoint that allows Study instances to be viewed or edited.

aggregate(request) → rest_framework.response.Response¶

Returns related model counts if count filtering is enabled.

Parameters:	request (Request) – API request
Returns:	Aggregated queryset or informational message
Return type:	Response

basename = None¶

description = None¶

detail = None¶

filter_class¶: alias of research.filters.study_filter.StudyFilter

filter_queryset(queryset)¶

Filters the returned study queryset according to the user’s collaborations.

Parameters:	queryset (QuerySet) – Base Study queryset
Returns:	Studies in which the user is a collaborator
Return type:	QuerySet

get_queryset() → django.db.models.query.QuerySet¶

Overrides the parent get_queryset() method to apply aggregated annotation if count filtering is enabled.

Returns:	Patient queryset
Return type:	QuerySet

name = None¶

queryset¶

serializer_class¶: alias of research.serializers.study.StudySerializer

suffix = None¶

research.views.subject module¶

Definition of the SubjectViewSet class.

class research.views.subject.SubjectViewSet(**kwargs)¶

Bases: pylabber.views.defaults.DefaultsMixin, rest_framework.viewsets.ModelViewSet

API endpoint that allows Subject instances to be viewed or edited.

basename = None¶

description = None¶

detail = None¶

export_files(request)¶

filter_class¶: alias of research.filters.subject_filter.SubjectFilter

filter_queryset(queryset)¶

Given a queryset, filter it with whichever filter backend is in use.

You are unlikely to want to override this method, although you may need to call it either from a list view, or from a custom get_object method if you want to apply the configured filtering backend to the default queryset.

get_serializer_class()¶

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

name = None¶

ordering_fields = ('id', 'id_number', 'first_name', 'last_name', 'date_of_birth', 'sex', 'dominant_hand', 'created', 'modified', 'latest_mri_session_time', 'mri_session_count')¶

plot(request, *args, **kwargs)¶

plot_script(request, *args, **kwargs)¶

plot_summary(request, *args, **kwargs)¶

queryset¶

suffix = None¶

to_csv(request, *args, **kwargs)¶