Added function documentation
This commit is contained in:
parent
fff8574b82
commit
1cc0fba114
3 changed files with 28 additions and 0 deletions
|
|
@ -21,6 +21,7 @@ export(linkage)
|
||||||
export(load_fasta)
|
export(load_fasta)
|
||||||
export(logml2String)
|
export(logml2String)
|
||||||
export(lueGenePopData)
|
export(lueGenePopData)
|
||||||
|
export(lueGenePopDataPop)
|
||||||
export(lueNimi)
|
export(lueNimi)
|
||||||
export(noIndex)
|
export(noIndex)
|
||||||
export(ownNum2Str)
|
export(ownNum2Str)
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,9 @@
|
||||||
|
#' @title Read GenePop Data
|
||||||
|
#' @note The data is given in the form where the last column tells the
|
||||||
|
#' group. popnames are as before.
|
||||||
|
#' @param tiedostonNimi Name of the file
|
||||||
|
#' @return List containing data and popnames
|
||||||
|
#' @export
|
||||||
lueGenePopDataPop <- function(tiedostonNimi) {
|
lueGenePopDataPop <- function(tiedostonNimi) {
|
||||||
# Data annetaan muodossa, jossa viimeinen sarake kertoo ryhmän.
|
# Data annetaan muodossa, jossa viimeinen sarake kertoo ryhmän.
|
||||||
# popnames on kuten ennenkin.
|
# popnames on kuten ennenkin.
|
||||||
|
|
|
||||||
21
man/lueGenePopDataPop.Rd
Normal file
21
man/lueGenePopDataPop.Rd
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
% Generated by roxygen2: do not edit by hand
|
||||||
|
% Please edit documentation in R/lueGenePopDataPop.R
|
||||||
|
\name{lueGenePopDataPop}
|
||||||
|
\alias{lueGenePopDataPop}
|
||||||
|
\title{Read GenePop Data}
|
||||||
|
\usage{
|
||||||
|
lueGenePopDataPop(tiedostonNimi)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{tiedostonNimi}{Name of the file}
|
||||||
|
}
|
||||||
|
\value{
|
||||||
|
List containing data and popnames
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
Read GenePop Data
|
||||||
|
}
|
||||||
|
\note{
|
||||||
|
The data is given in the form where the last column tells the
|
||||||
|
group. popnames are as before.
|
||||||
|
}
|
||||||
Loading…
Add table
Reference in a new issue