Skip to content

Commit

Permalink
minor improvemtns to docs, remove non-standard symbols
Browse files Browse the repository at this point in the history
  • Loading branch information
dbdimitrov committed Aug 6, 2024
1 parent db27f37 commit 2dbf055
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 11 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: liana
Type: Package
Title: LIANA: a LIgand-receptor ANalysis frAmework
Version: 0.1.14
Version: 0.1.15
Authors@R: c(
person(
given = "Daniel",
Expand All @@ -19,7 +19,7 @@ Authors@R: c(
),
person(
given = "Martin",
family = "Garrido Rodríguez",
family = "Garrido Rodriguez",
role = c("aut"),
email = "martin.garrido@uni-heidelberg.de",
comment = c(ORCID = "0000-0003-4125-5643")
Expand Down
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# LIANA 0.1.15 (06.08.24)

- Minor tutorial improvements.

- Remove non-standard symbols from description.

# LIANA 0.1.14 (15.02.24)

- Orthology translation uses OMA instead of the outdated NCBI HomoloGene
Expand Down
10 changes: 3 additions & 7 deletions tests/testthat/test-liana_tensor.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,10 @@ test_that("Test tensor wrapper", {
inplace = FALSE
)

# fix random bs exceptions
exp1 <- map(exp1, ~.x %>% mutate(across(where(is.factor), ~as.character(.x))))
res1 <- map(res1, ~.x %>% mutate(across(where(is.factor), ~as.character(.x))))
sum_res1 <- round(colSums(res1$contexts[, sapply(res1$contexts, is.numeric)]), 5)
sum_exp1 <- round(colSums(exp1$contexts[, sapply(exp1$contexts, is.numeric)]), 5)
expect_true(identical(sum_res1, sum_exp1))

expect_true(all_equal(res1$contexts, exp1$contexts))
expect_true(all_equal(res1$interactions, exp1$interactions))
expect_true(all_equal(res1$senders, exp1$senders))
expect_true(all_equal(res1$receivers, exp1$receivers))
})

test_that("Test decompose_tensor", {
Expand Down
2 changes: 0 additions & 2 deletions tests/testthat/test-liana_utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ test_that("Test generate_homologs", {
"testdata",
"output",
"op_ortho.RDS"))

expect_equal(res1, op_ortho)
})


Expand Down
15 changes: 15 additions & 0 deletions vignettes/liana_cc2tensor.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,21 @@ This tensor is then decomposed into a set of factors, which can be interpreted a
low dimensionality latent variables (vectors) that capture the
CCC patterns across contexts.


## Updated Tutorials


We have written extensive in both Python and R:
https://ccc-protocols.readthedocs.io/en/latest/notebooks/ccc_R/QuickStart.html

We recommend following those, after you setup a conda environment with both LIANA and Tensor-cell2cell following the instructions here:
https://github.com/saezlab/ccc_protocols/tree/main/env_setup

We also recommend using the more efficient and completele version of LIANA - i.e. LIANA+ (in Python):
https://ccc-protocols.readthedocs.io/en/latest/notebooks/ccc_python/QuickStart.html


## Simple (Outdated) Example

Here, we will combine `LIANA` with `tensor_cell2cell` to decipher potential ligand-receptor
interaction changes.
Expand Down
6 changes: 6 additions & 0 deletions vignettes/liana_tutorial.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ corresponding resources.

![](ligrec_pipe.png)

## LIANA's development continous as LIANA+

We recommend all users to consider using [LIANA+](https://liana-py.readthedocs.io/en/latest/index.html), instead of LIANA, due to it's increased efficiency and completeness.
We plan to eventually port all LIANA+ functionalities and backend to R, but in the meantime [LIANA+ in Python](https://liana-py.readthedocs.io/en/latest/index.html) is recommended.


## Load required packages
```{r load_pkgs, message=FALSE, warning=FALSE}
library(tidyverse)
Expand Down

0 comments on commit 2dbf055

Please sign in to comment.