synGetEvaluation: synGetEvaluation

Description Usage Details See Also Examples

Description

Function to retrieve an Evaluation object.

Usage

1
2

Details

synGetEvaluation retrieves an Evaluation object, given its ID. synGetEvaluationByContentSource retrieves all Evaluations that derive their content from a Project, give its ID.

See Also

synStore

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
## Not run: 
# get an arbitrary Evaluation ID
anEvaluationId<-synRestGET("/evaluation")$results[[1]]["id"]
# retrieve the evaluation
evaluation<-synGetEvaluation(anEvaluationId)
# check its status
propertyValue(evaluation, "status")
# if I have administrative privileges I can update it
propertyValue(evaluation, "description")<-"some new description"
evaluation<-synStore(evaluation)

# Or if you know a project with an evaluation
# For example, the HPN-DREAM 1A challenge
projectId <- "syn1720047" 
paginatedEvaluations <- synGetEvaluationByContentSource(projectId)
evaluation <- paginatedEvaluations@results[[1]]

## End(Not run)

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