Evaluation: Evaluation Constructor

Description Usage Arguments Slots See Also

Description

Constructor for Evaluation

Usage

1
Evaluation(name, description, contentSource, status, quota, submissionInstructionsMessage, submissionReceiptMessage)

Arguments

name

name for this Evaluation.

description

description of this Evaluation

contentSource

Synapse ID of the entity which owns the Evaluation, usually a Project

status

One of "PLANNED", "OPEN", "CLOSED", or "COMPLETED". This field is currently required, but is unused and will be removed in the future.

quota

An object of type SubmissionQuota describing the maximum submissions by an individual or a team per round, as well as the beginning, duration and number of rounds in the Challenge. Both the maximum and the rounds are optional. See the documentation for SubmissionQuota for further details.

submissionInstructionsMessage

Instructions to be show to participants on how to craft Synapse File objects for submission to the Evaluation.

submissionReceiptMessage

Message to display by client upon successful submission to the Evaluation.

Slots

updateUri

Synapse URI which will be used to update the Evaluation

properties

Synapse properties for an Evaluation object. Properties of interest include:

id

unique Synapse ID as set by the system upon synStore (not set by user)

name

user supplied name for the Evaluation

description

user supplied description of the Evaluation

contentSource

Synapse ID of the entity which owns the Evaluation (usually a Project)

status

status of the Evaluation - one of: "PLANNED", "OPEN", "CLOSED", or "COMPLETED"

submissionInstructionMessage

Instructions to be show to participants on how to craft Synapse File objects for submission to the Evaluation.

submissionInstructionMessage

Message to display by client upon successful submission to the Evaluation.

See Also

synGetEvaluation synStore submit SubmissionQuota


Sage-Bionetworks/rSynapseClient documentation built on May 9, 2019, 7:04 p.m.