R/ti_comp1.R

In dynverse/dynmethods: A collection of trajectory inference methods

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

#' @title Component 1
#' 
#' @description
#' Will generate a trajectory using Component 1.
#' 
#' This method was wrapped inside a
#' [container](https://github.com/dynverse/ti_comp1).
#' 
#' 
#' 
#' 
#' @param dimred Which dimensionality reduction method to use. Domain: {pca, mds,
#' tsne, ica, lle, landmark_mds, mds_sammon, mds_isomds, mds_smacof, umap,
#' dm_diffusionMap}. Default: pca. Format: character.
#' @param ndim . Domain: U(2, 30). Default: 2. Format: integer.
#' @param component . Domain: U(1, 10). Default: 1. Format: integer.
#' 
#' @keywords method
#' 
#' @return A TI method wrapper to be used together with
#' \code{\link[dynwrap:infer_trajectories]{infer_trajectory}}
#' @export
ti_comp1 <- function(
    dimred = "pca",
    ndim = 2L,
    component = 1L
) {
  method_choose_backend(
    package_repository = NULL,
    package_name = NULL,
    function_name = NULL,
    package_version = NULL,
    container_id = "dynverse/ti_comp1:v0.9.9.01"
  )(
    dimred = dimred,
    ndim = ndim,
    component = component
  )
}