saveAcasFile: save file in ACAS

View source: R/updateExperimentMetadata.R

saveAcasFileR Documentation

save file in ACAS

Description

Saves a file into a file service and saves a reference to it in the provided entity

Usage

saveAcasFile(fileStartLocation, entity, entityKind, stateType, stateKind,
  valueKind, recordedBy, lsTransaction, valueType = "fileValue",
  additionalPath = "", experimentCodeName = NULL,
  fileServiceType = racas::applicationSettings$server.service.external.file.type,
  fileService = racas::applicationSettings$server.service.external.file.service.url,
  deleteOldFile = TRUE, customSourceFileMove = NULL,
  lsServerURL = racas::applicationSettings$client.service.persistence.fullpath)

Arguments

fileStartLocation

path to file, relative from privateUploads

entity

an entity object, such as an experiment

entityKind

the kind of entity, such as "experiment" or "analysisgroup", see acasEntityHierarchy

stateType

the stateType of save location, e.g. "metadata"

stateKind

the stateKind of save location, e.g. "experiment metadata"

valueKind

the valueKind, or description of the file e.g. "source file"

recordedBy

username of current user

lsTransaction

the id of the transaction

valueType

usually fileValue, could also be inlineFileValue

additionalPath

if saving to a file system and not a service, additional file organization, i.e. "analysis/final"

fileServiceType

"blueimp" for internal, "custom" for custom

fileService

only required if fileServiceType is "custom", path to custom file service

deleteOldFile

boolean, TRUE if current file should be deleted after a copy is made

customSourceFileMove

function for custom moving file to server

lsServerURL

the url for the roo server

Details

sets the "status" value in state "analysis status" (or "dryrun status" if dryRun == TRUE). Mostly used by saveAcasFileToExperiment. In updateExperimentMetadata.R


mcneilco/racas documentation built on April 19, 2024, 1:12 p.m.