Diff of /man/KmeanOrder.Rd [000000] .. [28e211]

Switch to side-by-side view

--- a
+++ b/man/KmeanOrder.Rd
@@ -0,0 +1,43 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/DIscBIO-generic-clusteringOrder.R
+\name{KmeanOrder}
+\alias{KmeanOrder}
+\alias{KmeanOrder,DISCBIO-method}
+\title{Pseudo-time ordering based on k-means clusters}
+\usage{
+KmeanOrder(
+  object,
+  quiet = FALSE,
+  export = FALSE,
+  filename = "Cellular_pseudo-time_ordering_based_on_k-meansc-lusters"
+)
+
+\S4method{KmeanOrder}{DISCBIO}(
+  object,
+  quiet = FALSE,
+  export = FALSE,
+  filename = "Cellular_pseudo-time_ordering_based_on_k-meansc-lusters"
+)
+}
+\arguments{
+\item{object}{\code{DISCBIO} class object.}
+
+\item{quiet}{if `TRUE`, suppresses intermediary output}
+
+\item{export}{if `TRUE`, exports order table to csv}
+
+\item{filename}{Name of the exported file (if `export=TRUE`)}
+}
+\value{
+The DISCBIO-class object input with the kordering slot filled.
+}
+\description{
+This function takes the exact output of exprmclust function and
+  construct Pseudo-time ordering by mapping all cells onto the path that
+  connects cluster centers.
+}
+\note{
+This function has been replaced by pseudoTimeOrdering(), but it is
+  being kept for legacy purposes. It will, however, be removed from future
+  versions of DIscBIO.
+}