skbio.metadata.SampleMetadata.write#

SampleMetadata.write(file, format='sample_metadata', **kwargs)[source]#

Write an instance of SampleMetadata to a file.

This is a convenience method for skbio.io.registry.write(). For more information about the I/O system in scikit-bio, please see skbio.io.

Supported file formats include:

Parameters:

fileopenable (filepath, URL, filehandle, etc.): The location to write the given format into. Something that is understood by skbio.io.util.open(). Filehandles are not automatically closed, it is the responsibility of the caller.
formatstr: The format must be a registered format name with a writer for SampleMetadata. Default is ‘sample_metadata’.
kwargsdict, optional: Keyword arguments passed to skbio.io.registry.write() and the file format writer.