| prolific.api-package {prolific.api} | R Documentation |
R interface to the Prolific API
Description
A set of user-friendly functionalities for creating and managing potentially large numbers of studies on the Prolific platform via its API. The platform is designed for recruiting participants for empirical studies via crowd-sourcing, allowing to apply a number of prescreening characteristics to target specific groups of participants for a study.
Object classes
prolific.api provides three ReferenceClasses to access the Prolific API,
namely
api_access, prolific_study and prolific_prescreener.
An overview is provided below.
api_access
api_access objects
provide functionalities for accessing the API,
which requires to specify a valid API token.
prolific_study
prolific_study objects
represent studies to be created or managed on Prolific.
Users can create new studies, or retrieve existing studies from Prolific and apply updates to them.
prolific_prescreener
prolific_prescreener objects
characterize the participants to be selected for a certain prolific_study,
i.e. the requirements that a person needs to meet to be recruited for the study.
Authentication
A researcher account on Prolific is required to use the functionalities of this package.
To use this account, a valid Prolific API token must be specified
for authentication. These tokens are workspace-specific and
can be managed in the Settings -> Go to API token page menu
(https://app.prolific.co/researcher/workspaces/workspace_id/settings/tokens for an existing workspace_id).