exprmat Main Module#

Core Exported Classes#

The package primarily exports two core classes: metadata and experiment. These two classes are respectively an encapsulation of the experimental metadata table and an in-memory representation of a dataset. In general, you first need to create a metadata table specifying where and in what format to read data from disk. The package will automatically convert the data into a unified in-memory format based on the specified data types and store it in an experiment object. You can manipulate this object and save it to disk. A disk dataset format is a directory with a specific structure. You can package it with tar for transfer and sharing.

class experiment#: See exprmat.experiment and exprmat.load_experiment()

class metadata#: See exprmat.metadata and exprmat.load_metadata()

Utility Functions#

The main module exports several functions for identifying the package version, database version, memory usage, and managing the working directory. You can use these functions to prepare for subsequent program operations.

version_db()#: Returns the version string of the database registered and found by the package. In the format of major, minor and revision in integral tuples of 3. Example: (0, 1, 29)

version()#: Returns the version of the main source package. You should ensure the version of the package be identical to the database. Otherwise bugs may happen anywhere. In the format of major, minor and revision in integral tuples of 3. Example: (0, 1, 29)

memory()#: Print the currently dedicated and virtual memory. Do not return anything.

setwd(path: str = '.')#: Set the working directory. An alias of os.chdir().

getwd()#: Get the working directory. An alias of os.getcwd().

Getting Started with the exprmat Package#

You can continue reading the following documentation. These tutorials briefly introduce the basic workflow of the package.

Metadata