|
a |
|
b/man/KmeanOrder.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/DIscBIO-generic-clusteringOrder.R |
|
|
3 |
\name{KmeanOrder} |
|
|
4 |
\alias{KmeanOrder} |
|
|
5 |
\alias{KmeanOrder,DISCBIO-method} |
|
|
6 |
\title{Pseudo-time ordering based on k-means clusters} |
|
|
7 |
\usage{ |
|
|
8 |
KmeanOrder( |
|
|
9 |
object, |
|
|
10 |
quiet = FALSE, |
|
|
11 |
export = FALSE, |
|
|
12 |
filename = "Cellular_pseudo-time_ordering_based_on_k-meansc-lusters" |
|
|
13 |
) |
|
|
14 |
|
|
|
15 |
\S4method{KmeanOrder}{DISCBIO}( |
|
|
16 |
object, |
|
|
17 |
quiet = FALSE, |
|
|
18 |
export = FALSE, |
|
|
19 |
filename = "Cellular_pseudo-time_ordering_based_on_k-meansc-lusters" |
|
|
20 |
) |
|
|
21 |
} |
|
|
22 |
\arguments{ |
|
|
23 |
\item{object}{\code{DISCBIO} class object.} |
|
|
24 |
|
|
|
25 |
\item{quiet}{if `TRUE`, suppresses intermediary output} |
|
|
26 |
|
|
|
27 |
\item{export}{if `TRUE`, exports order table to csv} |
|
|
28 |
|
|
|
29 |
\item{filename}{Name of the exported file (if `export=TRUE`)} |
|
|
30 |
} |
|
|
31 |
\value{ |
|
|
32 |
The DISCBIO-class object input with the kordering slot filled. |
|
|
33 |
} |
|
|
34 |
\description{ |
|
|
35 |
This function takes the exact output of exprmclust function and |
|
|
36 |
construct Pseudo-time ordering by mapping all cells onto the path that |
|
|
37 |
connects cluster centers. |
|
|
38 |
} |
|
|
39 |
\note{ |
|
|
40 |
This function has been replaced by pseudoTimeOrdering(), but it is |
|
|
41 |
being kept for legacy purposes. It will, however, be removed from future |
|
|
42 |
versions of DIscBIO. |
|
|
43 |
} |