Added function documentation

This commit is contained in:
Waldir Leoncio 2022-05-13 12:39:57 +02:00
parent fff8574b82
commit 1cc0fba114
3 changed files with 28 additions and 0 deletions

View file

@ -21,6 +21,7 @@ export(linkage)
export(load_fasta)
export(logml2String)
export(lueGenePopData)
export(lueGenePopDataPop)
export(lueNimi)
export(noIndex)
export(ownNum2Str)

View file

@ -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) {
# Data annetaan muodossa, jossa viimeinen sarake kertoo ryhmän.
# popnames on kuten ennenkin.

21
man/lueGenePopDataPop.Rd Normal file
View 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.
}