Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
VPetukhov committed Mar 25, 2022
1 parent 4ec0628 commit 951d105
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To install the package use:
``` r
devtools::install_github("kharchenkolab/cacoa")
```
## Usage
## Initialization

Cacoa currently supports inputs in several formats (see below). Most of them require the following metadata:

Expand Down Expand Up @@ -70,6 +70,8 @@ cao <- Cacoa$new(co, sample.groups=sample.groups, cell.groups=cell.groups,

For visualization purpuses, Conos must have cell embedding estimated or the embedding data frame must be provided in the `embedding` parameter. And for cluster-free analysis it should have a joint graph (see the method `Conos$buildGraph()` from [conos](https://CRAN.R-project.org/package=conos) method).

## Example
## Usage

Cacoa can estimate and visualize various statistics. Most of them have paired functions `cao$estimateX(...)` and `cao$plotX(...)` (for example, `cao$estimateCellLoadings()` and `cao$plotCellLoadings()`). Results of all estimation are stored in `cao$test.results`, and their exact name can be controlled by `name` parameter passed to `cao$estimateX()`. For example, calling `cao$estimateExpressionShiftMagnitudes(name='es')` would save the results in `cao$test.results$es`.

See [the vignette](http://pklab.med.harvard.edu/viktor/cacoa/ep.html) for an example.
Please, see the documentation for exact functions inside the package. For a demonstration see [the vignette](http://pklab.med.harvard.edu/viktor/cacoa/ep.html). Additionally, the [cacoaAnalysis](https://github.com/kharchenkolab/cacoaAnalysis/) repository contains analysis conducted inside the paper, though the Cacoa version there may be out of date.

0 comments on commit 951d105

Please sign in to comment.