WOTPLY
WOTPLY (Waddington-OT analysis PLot) is an R package that shows the connections between selected clusters from the latest time point and the clusters from all the previous time points. The transition matrices between time point t and t+1 are obtained from Waddington-OT analysis (python package wot).
Installation
You can install the development version from GitHub with:
devtools::install_github("ScialdoneLab/WOTPLY", ref="main")
Getting started
The main function of the package is WOTPLY
WOTPLY
WOTPLY(list_transition_matrices, selected_stages, cluster_label, time_label, legend_time, customize_color, top_link = NULL)
requires as input:
- list_transition_matrices: List of transition matrices. Each matrix contains the transition probailities from the clusters at time t (on the columns) towards the clusters at time t+1 (on the rows). The matrices can be obtain from funtion get_transition_matrix
- selected_stages: Vector with the name of the clusters related to the latest time point for which we want to know the connection to clusters at previous time points.
- cluster_label Vector with the cluster information for all the cells from all time points. The length is equal to the one of time_label
- time_label Vector with time information for all the cells from all time points. The length is equal to the one of cluster_label
- legend_time Vector with time information with length equal to the number of time points.
- customize_color Character vector with the name of the colours for each cluster (node) in each time point.
- top_link Integer.Maximum number of links to select between clusters at time t and clusters at time t+1. Links are sorted according to the weigth and then only the top_link are kept. If NULL (default), all the links are kept.
A ggnet2 plot is generated showing the connections between selected_stages from the latest time point and the clusters from previous time points . The number of columns is equal to the numbers of time points. In each column, the cluster of the corresponding time point is shown as network node. The weight of the links between clusters at time points t and t+1 refelect the weigth of the transition probabilities from list_transition_matrices.
Example
Below an example of input using the development version of WOTPLY from GitHub The analysis performed on a single cell RNA seq dataset from a time-course of iPS reprogramming. The data are from day 10, day 12, day 14, day 16 and day 18 from Schiebinger et al. 2019. Below the transition matrices bewteen time points t and t+1 are loaded. Each matrix is the output of get_transition_matrix and was built starting from compute_all_transport_maps function from pyhton package wot). See ?get_transition_matrix for more info.
load(system.file("extdata", "cluster_label_example.Rda", package = "WOTPLY"))
load(system.file("extdata", "example_day_10_12.Rda", package = "WOTPLY"))
load(system.file("extdata", "example_day_12_14.Rda", package = "WOTPLY"))
load(system.file("extdata", "example_day_14_16.Rda", package = "WOTPLY"))
load(system.file("extdata", "example_day_16_18.Rda", package = "WOTPLY"))
list_transition_matrices_example <- list(example_day_10_12,example_day_12_14,example_day_14_16,example_day_16_18)
selected_stages <- c("IPS","Trophoblast","Epithelial","STROMAL","NEURAL")
legend_time_example <- c("day_10","day_12","day_14","day_16","day_18")
customize_color <- WOTPLY:::gg_color_hue(length(levels(factor(cluster_label_example))))
The output of WOTPLY function shows the connections between selected_stages from the latest time point and the clusters from previous time points. The number of columns is equal to the numbers of time points. In each column, the cluster of the corresponding time point is shown as network node. The weight of the links between clusters at time points t and t+1 refelects the weigth of the transition probabilities from list_transition_matrices. It is possible to change the maximum number of links to select between clusters at time t and clusters at time t+1. Links are sorted according to the weigth and then only the top_link are kept. If NULL (default), all the links are kept.
WOTPLY(list_transition_matrices_example, selected_stages, cluster_label_example, legend_time_example, customize_color, top_link = NULL)
WOTPLY(list_transition_matrices_example, selected_stages, cluster_label_example, legend_time_example, customize_color, top_link = 3)
Vignette
The following vignette is available and completely reproducible.
It can be accessed within R with:
utils::vignette("WOTPLY_vignette")
Contributions and Support
Contributions in the form of feedback, comments, code and bug report are welcome.
- For any contributions, feel free to fork the source code and submit a pull requests.
- Please report any issues or bugs here: https://github.com/ScialdoneLab/WOTPLY/issues. Any questions and requests for support can also be directed to the package maintainer (gabriele[dot]lubatti[at]helmholtz-muenchen[dot]de).