Writing RDML file-format plugins

The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

RDML7 authors

The format registry

listRDMLFormats()

A registered format may contain a reader, writer, sniffer, aliases, priority, capabilities, and API version.

Register a reader

registerRDMLFormat(
  name = "mydevice",
  extensions = "foo",
  apiVersion = 1L,
  capabilities = c("adp", "basicMetadata"),
  reader = function(fileName, ...) {
    # return rdmlType or rdmlImportData
  }
)

Intermediate importer objects

Table-like formats should normally return rdmlImportData.

series <- newRDMLImportSeries(
  fdataType = "adp",
  fdata = fdata,
  description = description
)

parsed <- newRDMLImportData(
  series = list(series),
  publisher = "My instrument",
  format = "mydevice"
)

readRDML() calls buildRDMLImport() automatically for such a result.

Minimum description columns are:

fdataName
expId
runId
reactId
target

Provide sample, sampleType, and targetDyeId when new metadata objects must be created.

Sniffers

A sniffer returns confidence from 0 to 1.

mySniff <- function(fileName) {
  first <- readLines(fileName, n = 1L, warn = FALSE)

  if (length(first) && startsWith(first, "MYDEVICE")) {
    return(1)
  }

  0
}

This permits shared extensions such as .txt and .csv.

Lossy conversions

loss <- newRDMLLossRecord(
  code = "unsupportedVendorField",
  message = "Vendor field X cannot be represented in RDML",
  path = "run.run1",
  details = list(field = "X")
)

parsed$losses <- list(loss)

The user’s loss = "warn", "error", or "allow" setting controls how these records are signalled.

Module files

A module defines rdmlModule() and returns one or more registry specifications.

rdmlModule <- function() {
  list(
    name = "mydevice",
    extensions = "foo",
    reader = myReader,
    sniff = mySniff,
    apiVersion = 1L,
    capabilities = c("adp", "intermediate")
  )
}

Load it with:

loadRDMLModule("mydevice-module.R")

The historical factory name rdml_module() is also accepted.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.