Commit cb97630c by Eric Coissac

Add doc

parent 51b0b7be
#'
#' @import MASS #' @import MASS
#' #'
NULL NULL
...@@ -7,6 +6,15 @@ library(MASS) ...@@ -7,6 +6,15 @@ library(MASS)
#' Project a distance matrix in a euclidean space (NMDS). #' Project a distance matrix in a euclidean space (NMDS).
#' #'
#' Project a set of points defined by a distance matrix in
#' an eucleadean space using the Kruskal's Non-metric
#' Multidimensional Scaling. This function is mainly a simplified
#' interface on the \code{\link[MASS]{isoMDS}} function using as
#' much as possible dimensionsto limit the stress. The aims of this
#' NDMS being only to project point in an orthogonal space therefore
#' without any correlation between axis. Because a non-metric method
#' is used no condition is required on the used distance.
#'
#' @author Eric Coissac #' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima #' @author Christelle Gonindard-Melodelima
#' @export #' @export
...@@ -40,6 +48,16 @@ nmds = function(distances, ...@@ -40,6 +48,16 @@ nmds = function(distances,
#' Project a distance matrix in a euclidean space (PCOA). #' Project a distance matrix in a euclidean space (PCOA).
#' #'
#' Project a set of points defined by a distance matrix in
#' an eucleadean space using the Principal Coordinates Analysis
#' method. This function is mainly a simplified
#' interface on the \code{\link[stats]{cmdscale}} function using as
#' much as possible dimensions for the projection. The aims of this
#' PCoA being only to project point in an orthogonal space therefore
#' without any correlation between axis. Because a metric method
#' is used the used distance must be euclidean
#' (cf \code{\link[ProcMod]{is.euclid}}).
#'
#' @author Eric Coissac #' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima #' @author Christelle Gonindard-Melodelima
#' @export #' @export
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment