WorkFileProperties: Retrieve, update, or list WorkFileProperties record(s)
In agower/GeneHive: R interface to a GeneHive

WorkFileProperties

R Documentation

Retrieve, update, or list WorkFileProperties record(s)

Description

These functions attempt to retrieve a WorkFileProperties record or to list WorkFileProperties records.

Usage

getWorkFileProperties(id, con = hiveConnection())

updateWorkFileProperties(
  id,
  ...,
  con = hiveConnection(),
  verbose = getOption("GeneHive.verbose")
)

listWorkFileProperties(
  ...,
  isTrashed = FALSE,
  con = hiveConnection(),
  simplify = TRUE
)

listWorkFiles(..., isTrashed = FALSE, con = hiveConnection(), simplify = TRUE)

Arguments

`id`	A `hiveWorkFileID` object (or coercible to one) specifying the unique identifier of a `WorkFileProperties` record. Automatically populated when a `WorkFile` is uploaded.
`con`	A `hiveConnection` object; if not provided, a new connection will be established
`...`	Additional arguments specifying fields of the `WorkFileProperties` record to be updated, or fields on which to limit a listing
`verbose`	A logical value specifying whether messages should be printed
`isTrashed`	A logical value specifying how to limit the result with respect to trashed records. If `FALSE` (default), only untrashed records are returned; if `TRUE`, only trashed records are returned; if `NA`, both trashed and untrashed records are returned.
`simplify`	A logical value specifying whether to return the listing as a data frame

Value

getWorkFileProperties

If the operation is successful, a hiveWorkFileProperties object.

updateWorkFileProperties

If the operation is successful, a hiveWorkFileProperties object (invisibly).

listWorkFileProperties

If simplify = TRUE: A data frame containing one row per record and one column per field.
If simplify = FALSE: A SimpleList object containing one hiveWorkFileProperties object per record.

All functions