addFileLink: Saves a file that will show up as a link in Seurat

View source: R/batchAnnotation.R

addFileLinkR Documentation

Description

Saves an analysis group with states and values holding a file or url. Each batchCode has a separate state with the annotation.

Usage

addFileLink(batchCodeList, recordedBy, experiment, lsTransaction,
  reportFileSummary = NULL, reportFilePath = NULL, fileType = NULL,
  url = NULL, testMode = FALSE)

Arguments

batchCodeList

A list or vector of batch codes

recordedBy

The username of the person recording the data

experiment

A list that is an experiment object, needs to have values for id, verison, and codeName

lsTransaction

A number that is a transaction id

reportFileSummary

A description of the file or url annotation

reportFilePath

The path to the report file (may be relative)

fileType

The type of the annotation, used by some custom services

url

A url (e.g. http://google.com)

testMode

a boolean used for testing

Details

Must have either a reportFilePath or a url, but having both will result in the url being ignored.


mcneilco/racas documentation built on Aug. 30, 2024, 9:27 p.m.