max/ourMELONS
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Updated docs

Browse source
This commit is contained in:
Waldir Leoncio 2020-10-19 15:57:30 +02:00
parent 6b1a1910e3
commit 637df694bb
6 changed files with 77 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
NAMESPACE
View file

@ -23,6 +23,7 @@ export(linkage)
export(logml2String) export(logml2String)
export(lueGenePopData) export(lueGenePopData)
export(lueNimi) export(lueNimi)
export(max_MATLAB)
export(min_MATLAB) export(min_MATLAB)
export(noIndex) export(noIndex)
export(ownNum2Str) export(ownNum2Str)

11
man/admixture_initialization.Rd Normal file
View file

@ -0,0 +1,11 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/admixture_initialization.R
\name{admixture_initialization}
\alias{admixture_initialization}
\title{Seuraavat kolme funktiota liittyvat alkupartition muodostamiseen.}
\usage{
admixture_initialization(data_matrix, nclusters, Z)
}
\description{
Seuraavat kolme funktiota liittyvat alkupartition muodostamiseen.
}

4
man/laskeMuutokset4.Rd
View file

@ -1,5 +1,5 @@
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/laskeMuutokset4.R % Please edit documentation in R/laskeMuutokset12345.R
\name{laskeMuutokset4} \name{laskeMuutokset4}
\alias{laskeMuutokset4} \alias{laskeMuutokset4}
\title{Calculate changes?} \title{Calculate changes?}
@ -20,6 +20,6 @@ laskeMuutokset4(osuus, osuusTaulu, omaFreqs, logml, COUNTS = matrix(0))
\description{ \description{
Palauttaa npops*npops taulun, jonka alkio (i,j) kertoo, mik?on Palauttaa npops*npops taulun, jonka alkio (i,j) kertoo, mik?on
muutos logml:ss? mikäli populaatiosta i siirretään osuuden verran muutos logml:ss? mikäli populaatiosta i siirretään osuuden verran
todennäköisyysmassaa populaatioon j. Mikäli populaatiossa i ei ole mitään todennäköisyysmassaa populaatioon j. Mikäli populaatiossa i ei ole mitään
siirrettävää, on vastaavassa kohdassa rivi nollia. siirrettävää, on vastaavassa kohdassa rivi nollia.
} }

22
man/max_MATLAB.Rd Normal file
View file

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

18
man/min_MATLAB.Rd
View file

@ -1,11 +1,15 @@
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/min.R, R/min_MATLAB.R % Please edit documentation in R/min.R, R/min_MATLAB.R, R/min_max_MATLAB.R
\name{min_MATLAB} \name{min_MATLAB}
\alias{min_MATLAB} \alias{min_MATLAB}
\title{Minimum (MATLAB version)} \title{Minimum (MATLAB version)}
\usage{ \usage{
min_MATLAB(X, indices = TRUE) min_MATLAB(X, indices = TRUE)
min_MATLAB(X, indices = TRUE)
min_MATLAB(X, indices = TRUE)
min_MATLAB(X, indices = TRUE) min_MATLAB(X, indices = TRUE)
} }
\arguments{ \arguments{
@ -16,15 +20,27 @@ min_MATLAB(X, indices = TRUE)
\value{ \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
Either a list or a vector Either a list or a vector
} }
\description{ \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
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{ \author{
Waldir Leoncio Waldir Leoncio
Waldir Leoncio
Waldir Leoncio
Waldir Leoncio Waldir Leoncio
} }

24
man/setdiff_MATLAB.Rd Normal file
View file

@ -0,0 +1,24 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/setdiff.R
\name{setdiff_MATLAB}
\alias{setdiff_MATLAB}
\title{Set differences of two arrays}
\usage{
setdiff_MATLAB(A, B, legacy = FALSE)
}
\arguments{
\item{A}{first array}
\item{B}{second awway}
\item{legacy}{if `TRUE`, preserves the behavior of}
}
\value{
}
\description{
Loosely replicates the behavior of the homonym Matlab function
}
\author{
Waldir Leoncio
}