read.omexml: Read OME-XML Metadata

View source: R/read.omexml.R

read.omexmlR Documentation

Read OME-XML Metadata

Description

Read the OME-XML DOM tree.

Usage

read.omexml(file, filter.metadata = FALSE, proprietary.metadata = TRUE)

Arguments

file

character, file name

filter.metadata

logical, specifies whether ugly metadata (entries with unprintable characters, and extremely large entries) should be discarded from the metadata table

proprietary.metadata

logical, should proprietary metadata be populated to OME-XML

Value

A string containing a dumped OME-XML DOM tree.

Author(s)

Andrzej OleÅ› <andrzej.oles@gmail.com>, 2014-2023

See Also

read.metadata for reading image metadata, read.image for reading image data

Examples

require(EBImage)
f = system.file("images", "nuclei.tif", package="EBImage")

omexml = read.omexml(f)
omexml

aoles/RBioFormats documentation built on May 3, 2024, 7:46 a.m.