Skip to content

Commit

Permalink
enh: docs and examples updates
Browse files Browse the repository at this point in the history
- combine some docs
- add progress bar for exprCellCellcom instead of verbose prints
- remove some hardcoded param defaults and add catches
  • Loading branch information
jiajic committed May 28, 2024
1 parent 015bcb4 commit 5d9408e
Show file tree
Hide file tree
Showing 10 changed files with 423 additions and 471 deletions.
3 changes: 3 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
* Add catch in `runPCAprojectionBatch()` for when ncp requested exceeds number of feats used
* Make `spatCellCellcom()` respect `verbose` flag [#949](https://github.com/drieslab/Giotto/issues/949) by rbutleriii

## Enhancements
* `print()` methods for `icfObject` and `combIcfObject`

## Changes
* require GiottoUtils (>= 0.1.9)

Expand Down
14 changes: 8 additions & 6 deletions R/spatial_genes.R
Original file line number Diff line number Diff line change
Expand Up @@ -4053,7 +4053,7 @@ rankSpatialCorGroups <- function(gobject,



#' @title getBalancedSpatCoexpressionFeats
#' @title Get balanced spatial coexpression features
#' @name getBalancedSpatCoexpressionFeats
#' @description Extract features from spatial co-expression modules in a
#' balanced manner
Expand All @@ -4067,11 +4067,13 @@ rankSpatialCorGroups <- function(gobject,
#' @returns balanced vector with features for each co-expression module
#' @details There are 3 different ways of selecting features from the spatial
#' co-expression modules
#' \itemize{
#' \item{1. weighted: }{Features are ranked based on summarized pairwise co-expression scores}
#' \item{2. random: }{A random selection of features, set seed for reproducibility}
#' \item{3. informed: }{Features are selected based on prior information/ranking}
#' }
#' 1. **weighted:** Features are ranked based on summarized pairwise
#' co-expression scores
#' 2. **random:** A random selection of features, set seed for
#' reproducibility
#' 3. **informed:** Features are selected based on prior information/ranking
#'
#' @md
#' @export
getBalancedSpatCoexpressionFeats <- function(spatCorObject,
maximum = 50,
Expand Down
Loading

0 comments on commit 5d9408e

Please sign in to comment.