Skip to contents

Retrieves bundled Submissions and SubmissionStatuses for a given Evaluation.

Usage

synGetEvaluationSubmissionBundles(cls, evaluation_id, status=NULL, synapse_client=NULL)

Arguments

cls

(SubmissionBundle) The SubmissionBundle class (or an existing SubmissionBundle instance) to dispatch this call to.

evaluation_id

(character) The ID of the specified Evaluation.

status

(Optional[character]) Optionally filter submission bundles by status.

synapse_client

(Optional[Synapse]) If not passed in, the last created instance from the Synapse class constructor will be used.

Value

A GeneratorWrapper object that yields SubmissionBundle objects as they are retrieved from the API. Use as.list() to materialize all results into a list, or nextElem() to retrieve one SubmissionBundle at a time.

Note

The caller must be granted the READ_PRIVATE_SUBMISSION access type on the specified Evaluation.

Examples

if (FALSE) { # \dontrun{
## Getting submission bundles for an evaluation
    library(synapser)
    synLogin()

    bundles = as.list(SubmissionBundle() |> synGetEvaluationSubmissionBundles(
        evaluation_id = "9999999",
        status = "SCORED"
    ))
    print(sprintf("Found %d submission bundles", length(bundles)))
    for (bundle in bundles) {
        submission_id = if (is.null(bundle$submission)) "N/A" else bundle$submission$id
        print(sprintf("Submission ID: %s", submission_id))
    }
} # }