Skip to contents

Offers somewhat more convenient interface than the base dataset constructor: needs only item ids and creates structure needed + uses the LATEST version for items by default.

Usage

new_dataset(
  name,
  parent,
  items,
  item_version = NULL,
  addAnnotationColumns = FALSE,
  dry_run = TRUE
)

Arguments

name

Name of the dataset. It should be unique within the parent project.

parent

Synapse id of parent project where the dataset will live.

items

Id(s) of items to include. Usually the same parent project storing the files, but in some cases it may be a different project.

item_version

Integer for version that will be used for all items, e.g. 1. Otherwise, "latest" or "stable_latest". See details.

addAnnotationColumns

Whether to add annotation columns, default FALSE.

dry_run

If TRUE, don't actually store dataset, just return the data object for inspection or further modification.