data_publish: Publish a discovered or derived dataset to Synapse

Description Usage Arguments

View source: R/data.R

Description

Publish a discovered or derived dataset to Synapse

Usage

1
2
3
4
data_publish(obj, name = NULL, type = c("discovered", "derived"),
  file_type = c("rds", "csv", "txt"), desc = NULL, used = NULL,
  executed = NULL, activity = NULL, activity_name = NULL,
  activity_desc = NULL)

Arguments

obj

object to publish or a path to the file in your project's data/discovered or data/derived folder

name

name of the dataset being published

type

either "derived" or "discovered". If "discovered", it will go in data/discovered. If "derived", it will go in data/derived.

file_type

one of "rds", or "csv"

desc

description of the dataset

used

(optional) The Entity, Synapse ID, or URL used to create the object (can also be a list of these)

executed

(optional) The Entity, Synapse ID, or URL representing code executed to create the object (can also be a list of these)

activity

(optional) Activity object specifying the user's provenance

activity_name

(optional) Activity name to be used in conjunction with *used* and *executed*.

activity_desc

(optional) Activity description to be used in conjunction with *used* and *executed*.


ki-tools/kitools documentation built on Feb. 17, 2020, 7:10 p.m.