skbio.stats.ordination.OrdinationResults.read#
- OrdinationResults.read(format=None, **kwargs)[source]#
- Create a new - OrdinationResultsinstance from a file.- This is a convenience method for - skbio.io.registry.read. For more information about the I/O system in scikit-bio, please see- skbio.io.- Supported file formats include: - 'ordination'(- skbio.io.format.ordination)
 - Parameters:
- fileopenable (filepath, URL, filehandle, etc.)
- The location to read 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, optional
- The format of the file. The format must be a format name with a reader for - OrdinationResults. If None, the format will be inferred.
- kwargsdict, optional
- Additional arguments passed to - skbio.io.registry.readand the reader for- OrdinationResults.
 
- Returns:
- OrdinationResults
- A new instance.