Commit 3c759bbd by Eric Coissac

renames function is.euclid is_euclid

parent 489cafec
......@@ -26,7 +26,7 @@ export(bicenter)
export(corls)
export(corls_partial)
export(corls_test)
export(is.euclid)
export(is_euclid)
export(is_procmod_frame)
export(nmds)
export(ortho)
......
......@@ -107,7 +107,7 @@ nmds <- function(distances,
#' 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}}).
#' (cf \code{\link[ProcMod]{is_euclid}}).
#'
#' @param distances a \code{\link[stats]{dist}} object or a
#' \code{\link[base]{matrix}}
......@@ -211,7 +211,7 @@ bicenter <- function(m) {
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
is.euclid <- function(distances, tol = 1e-07) {
is_euclid <- function(distances, tol = 1e-07) {
if (!inherits(distances, "dist")) {
stop("Object of class 'dist' expected")
}
......@@ -268,7 +268,7 @@ ortho <- function(data, ...) {
#' @rdname ortho
#' @export
ortho.dist <- function(data, tol = 1e-7, ...) {
if (ProcMod::is.euclid(data, tol = tol)) {
if (ProcMod::is_euclid(data, tol = tol)) {
return(ProcMod::pcoa(data))
}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/multivariate.R
\name{is.euclid}
\alias{is.euclid}
\name{is_euclid}
\alias{is_euclid}
\title{Test if the distance matrix is euclidean.}
\usage{
is.euclid(distances, tol = 1e-07)
is_euclid(distances, tol = 1e-07)
}
\arguments{
\item{distances}{an object of class 'dist'}
......
......@@ -25,7 +25,7 @@ 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}}).
(cf \code{\link[ProcMod]{is_euclid}}).
}
\author{
Eric Coissac
......
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