synapseClient (version 1.14-0)

synGetParticipants: synGetParticipants

Description

Function to retrieve the Participants of an Evaluation.

Usage

synGetParticipants(evaluationId,limit,offset)

Arguments

evaluationId

The ID of the evaluation queue of interest.

limit

Optional pagination parameter: The number of results to return in the batch. Default (imposed by Synapse) is 10.

offset

Optional pagination parameter: The first result to return in the batch. Default is 0 (i.e. the first result).

Value

A PaginatedResults object containing a list of Participant objects.

See Also

synGetEvaluation

Examples

## Not run: 
# participants<-synGetParticipants("123456")
# participants@totalNumberOfResults
# participants@results
# ## End(Not run)