bakana-takane
v0.1.0
Published
Extensions to the bakana single-cell analysis pipeline to accept takane-formatted datasets and results. This facilitates interoperability with the rest of the ArtifactDB ecosystem.
Downloads
10
Maintainers
Readme
bakana extension for takane formats
Implements bakana-compatible readers for takane-formatted datasets and results. Developers can define subclasses to load data from their own local/remote sources, e.g., gypsum.
To demonstrate, we'll show how to read a dataset from the local filesystem with Node.js. Given a string containing some kind of "path" with Unix file separators, developers should define a method to get/list the contents of the file or directory.
import * as fs from "fs";
export function getFile(path) {
const contents = fs.readFileSync(path, null);
return new Uint8Array(contents);
}
export function listFiles(path) {
return fs.readdirSync(path);
}
We define a subclass of the AbstractDataset
:
import * as bt from "bakana-takane"
class LocalDataset extends bt.AbstractDataset {
constructor(path) {
super(path, getFile, listFiles);
}
// Extra methods required by bakana; omitting the
// serialize/unserialize methods for simplicity.
static format() {
return "local-takane";
}
abbreviate() {
return { "path": path };
}
};
Instances of our LocalDataset
can now be used in bakana:
const ds = new LocalDataset("/path/to/dataset");
let state = await bakana.createAnalysis();
let params = bakana.analysisDefaults();
await bakana.runAnalysis(state, { dataset: ds }, params);
Subclasses of the AbstractResult
are even easier to define:
class LocalResult extends bt.AbstractResult {
constructor(path) {
super(path, getFile, listFiles);
}
};