Installation

Setting Up the Environment (Preinstallation)

For Linux Users

Verify that the cmake version you are using is >=3.19.

For the optimal performance on Intel-based architectures, installing Intel Math Kernel Library (MKL) is highly recommended. After installing, make sure MKLROOT is defined by running the setvars script.

Install library dependencies To install the ACTIONet dependencie on debian-based linux machines, run:

sudo apt-get install libhdf5-dev libsuitesparse-dev libnss3 xvfb libblas-dev liblapack-dev cmake

Note: please use cmake>3.2 For Mac-based systems, you can use brew instead:

brew install hdf5 suite-sparse c-blosc blas lapack

Installing ACTIONet Python Package

Use pip to install ACTIONet directly from this repository:

pip install git+https://github.com/shmohammadi86/ACTIONet@python-devel

To install from source: git clone --recurse-submodules https://github.com/shmohammadi86/ACTIONet.git make install

Running ACTIONet

Note If you are using MKL, make sure to properly set the number of threads used prior to running ACTIONet.

Example Run

Here is a simple example to get you started:

import urllib.request

import ACTIONet as an
import scanpy as sc

# Download example dataset from the 10X Genomics website
opener = urllib.request.build_opener()
opener.addheaders = [('User-agent', 'Mozilla/5.0')]
urllib.request.install_opener(opener)
urllib.request.urlretrieve('http://cf.10xgenomics.com/samples/cell-exp/3.0.0/pbmc_10k_v3/pbmc_10k_v3_filtered_feature_bc_matrix.h5', 'pbmc_10k_v3.h5')

# Read and filter the data
adata = sc.read_10x_h5('pbmc_10k_v3.h5')
adata.var_names_make_unique(join='.')
an.pp.filter_adata(adata, min_cells_per_feature=0.01, min_features_per_cell=1000)
sc.pp.normalize_total(adata)
sc.pp.log1p(adata)

# Run ACTIONet
an.pp.reduce_kernel(adata)
an.run_ACTIONet(adata)

# Annotate cell-types
marker_genes, directions, names = an.tl.load_markers('PBMC_Monaco2019_12celltypes')
cell_labels, confidences, Z = an.tl.annotate_cells_using_markers(adata, marker_genes, directions, names)
adata.obs['celltypes'] = cell_labels

# Visualize output
an.pl.plot_ACTIONet(adata, 'celltypes', transparency_key='node_centrality')

# Export results
adata.write('pbmc_10k_v3.h5ad')

Visualizing results using cellxgene

The output of ACTIONet in the python implementation is internally stored as as AnnData object, and R ACE objects can be imported from/exported to AnnData using functions AnnData2ACE() and ACE2AnnData() functions, respectively. AnnData objects can be directly loaded into cellxgene package, an open-source viewer for interactive single-cell data visualization. cellxgene can be installed as:

pip install cellxgene

Then to visualize the results of ACTIONet, run:

cellxgene launch pbmc_10k_v3.h5ad

where pbmc_10k_v3.h5ad is the name of the file we exported using adata.write() function.

Additional tutorials

You can access ACTIONet tutorials from:

1. ACTIONet framework at a glance (human PBMC 3k dataset)
2. Introduction to the ACTIONet framework (human PBMC Granja et al. dataset)
3. Introduction to cluster-centric analysis using the ACTIONet framework
4. To batch correct or not to batch correct, that is the question!
5. PortingData: Import/export options in the ACTIONet framework
6. Interactive visualization, annotation, and exploration
7. Constructing cell-type/cell-state-specific networks using SCINET

You can also find a step-by-step guide to learning the core functionalities of the ACTIONet framework.