Improved docs

This commit is contained in:
Waldir Leoncio 2020-11-09 07:31:33 +01:00
parent 1dca4b290e
commit 03bec3b4b4
9 changed files with 19 additions and 90 deletions

View file

@ -6,6 +6,13 @@
\usage{
admixture_initialization(data_matrix, nclusters, Z)
}
\arguments{
\item{data_matrix}{data_matrix}
\item{nclusters}{ncluster}
\item{Z}{Z}
}
\description{
Seuraavat kolme funktiota liittyvat alkupartition muodostamiseen.
}

View file

@ -1,15 +1,9 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/min.R, R/min_MATLAB.R, R/min_max_MATLAB.R
% Please edit documentation in R/min_max_MATLAB.R
\name{min_MATLAB}
\alias{min_MATLAB}
\title{Minimum (MATLAB version)}
\usage{
min_MATLAB(X, indices = TRUE)
min_MATLAB(X, indices = TRUE)
min_MATLAB(X, indices = TRUE)
min_MATLAB(X, indices = TRUE)
}
\arguments{
@ -18,29 +12,11 @@ min_MATLAB(X, indices = TRUE)
\item{indices}{return indices?}
}
\value{
Either a list or a vector
Either a list or a vector
Either a list or a vector
Either a list or a vector
}
\description{
Finds the minimum value for each column of a matrix, potentially returning the indices instead
Finds the minimum value for each column of a matrix, potentially returning the indices instead
Finds the minimum value for each column of a matrix, potentially returning the indices instead
Finds the minimum value for each column of a matrix, potentially returning the indices instead
}
\author{
Waldir Leoncio
Waldir Leoncio
Waldir Leoncio
Waldir Leoncio
}

View file

@ -1,5 +1,5 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/setdiff.R
% Please edit documentation in R/setdiff_MATLAB.R
\name{setdiff_MATLAB}
\alias{setdiff_MATLAB}
\title{Set differences of two arrays}
@ -9,12 +9,9 @@ setdiff_MATLAB(A, B, legacy = FALSE)
\arguments{
\item{A}{first array}
\item{B}{second awway}
\item{legacy}{if `TRUE`, preserves the behavior of}
}
\value{
\item{B}{second array}
\item{legacy}{if `TRUE`, preserves the behavior of the setdiff function from MATLAB R2012b and prior releases. (currently not supported)}
}
\description{
Loosely replicates the behavior of the homonym Matlab function