contributeData: contributeData

In Sage-Bionetworks/rSCR: R functions for contributing to the Synapse Commons Repository

Usage

contributeData(contribution, project = NULL, keepLocal = FALSE, logFile = TRUE)

Arguments

contribution	Either a list containing properties or annotations for a single study / dataset, a dataframe with each row consisting of a single data entity to contribute, or a character string corresponding to a file name. Within the file should be a matrix with a header row, with each subsequent row consisting of a study / data entity to contribute.
project	The synapse ID corresponding to the project the user wishes to contribute data to.
keepLocal	A logical flag that determines if the data file will be deleted from the local file system once the entity has been created in Synapse.
logFile	A character string corresponding to a filename or set equal to TRUE in which case the log file will be set to a random file name.

Value

Either an entity or list of entities corresponding to the contributed data in synapse.

Author(s)

Brig Mecham <[e-mail]>

Examples

##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (contribution, project = NULL, keepLocal = FALSE, logFile = TRUE) 
{
    if (logFile == "TRUE") {
        logFile <- .setUpLogFile(logFile)
        cat("log file for this workflow: ", logFile, "\n")
    }
    project <- handleProject(project)
    translatedContribution <- handleContribution(project, contribution, 
        logFile)
    if (class(translatedContribution[[1]]) == "character") {
        layer <- contribute(translatedContribution, keepLocal, 
            logFile)
    }
    else {
        layer <- sapply(translatedContribution, function(x) {
            contribute(x, keepLocal, logFile)
        })
    }
    return(layer)
  }

Sage-Bionetworks/rSCR documentation built on May 9, 2019, 12:13 p.m.