readFileMeta: Retrieve saved file metadata for one or more files

In NCEAS/recordr: R Provenance Tracking

Description

File metadata is retrived from the recordr database table filemeta based on search parameters.

Usage

readFileMeta(recordr, ...)

## S4 method for signature 'Recordr'
readFileMeta(recordr, fileId = as.character(NA),
  executionId = as.character(NA), filePath = as.character(NA),
  sha256 = as.character(NA), user = as.character(NA),
  access = as.character(NA), format = as.character(NA),
  orderBy = as.character(NA), sortOrder = "ascending", delete = FALSE,
  ...)

Arguments

recordr	A recordr object
...	Additional parameters
fileId	The id of the file to search for
executionId	A character value that specifies an execution identifier to search for.
filePath	The path name of the file to search for.
sha256	The sha256 checksum value for the uncompressed file.
user	The user that ran the execution that created or accessed the file.
access	The type of access for the file. Values include "read", "write", "execute"
format	The format type of the object, e.g. "text/plain"
orderBy	The column to sort the result set by.
sortOrder	The sort type. Values include ("ascending", "descending")
delete	a "logical", if TRUE, the selected file entries are deleted (default: FALSE).

Details

This method is used internally by the recordr package.

Value

A dataframe containing file metadata objects

See Also

FileMetadata class description

NCEAS/recordr documentation built on May 7, 2019, 5:59 p.m.