R/ti_waterfall.R

Defines functions ti_waterfall

Documented in ti_waterfall

######################################### DO NOT EDIT! #########################################
#### This file is automatically generated from data-raw/2-generate_r_code_from_containers.R ####
################################################################################################

#' @title Waterfall
#' 
#' @description
#' Will generate a trajectory using
#' [Waterfall](https://doi.org/10.1016/j.stem.2015.07.013).
#' 
#' This method was wrapped inside a
#' [container](https://github.com/dynverse/ti_waterfall).
#' The original code of this method is available
#' [here](http://www.cell.com/cms/attachment/2038326541/2052521637/mmc9.zip).
#' 
#' @references Shin, J., Berg, D.A., Zhu, Y., Shin, J.Y., Song, J., Bonaguidi,
#' M.A., Enikolopov, G., Nauen, D.W., Christian, K.M., Ming, G., Song, H., 2015.
#' Single-Cell RNA-Seq with Waterfall Reveals Molecular Cascades underlying Adult
#' Neurogenesis. Cell Stem Cell 17, 360–372.
#' 
#' @param num_clusters . Domain: U(2, 20). Default: 10. Format: integer.
#' 
#' @keywords method
#' 
#' @return A TI method wrapper to be used together with
#' \code{\link[dynwrap:infer_trajectories]{infer_trajectory}}
#' @export
ti_waterfall <- function(
    num_clusters = 10L
) {
  method_choose_backend(
    package_repository = NULL,
    package_name = NULL,
    function_name = NULL,
    package_version = NULL,
    container_id = "dynverse/ti_waterfall:v0.9.9.01"
  )(
    num_clusters = num_clusters
  )
}
dynverse/dynmethods documentation built on Jan. 18, 2024, 4:44 a.m.