get_submissions_metadata: Get all submission metadata by state filter

In Sage-Bionetworks/synapseforms: Creates Reports From Synapse Submission Forms

Description

Get the metadata for all submissions by state filter: WAITING_FOR_SUBMISSION, SUBMITTED_WAITING_FOR_REVIEW, ACCEPTED, REJECTED.

Usage

get_submissions_metadata(
  syn,
  group,
  all_users = TRUE,
  state_filter = "SUBMITTED_WAITING_FOR_REVIEW"
)

Arguments

syn	Synapse login object
group	The groupID.
all_users	TRUE to get all submissions in group; FALSE to get group submissions from caller only.
state_filter	The filter that is desired to gather submissions by. Filters are: 'WAITING_FOR_SUBMISSION', 'SUBMITTED_WAITING_FOR_REVIEW', 'ACCEPTED', 'REJECTED'. Only accepts one filter.

Value

A dataframe of the submission metadata, or NULL if there are no submissions that meet the criteria.

Examples

## Not run: 

# Note: Must have permissions to access group.
# The example group will not work for most individuals.

syn <- log_into_synapse()

sub_meta_to_review <- get_submissions_metadata(
  syn = syn,
  group = 13
)

sub_meta_accepted <- get_submissions_metadata(
  syn = syn,
  state_filter = "ACCEPTED",
  group = 13
)

## End(Not run)

Sage-Bionetworks/synapseforms documentation built on June 16, 2020, 8:35 a.m.