Improved documentation

This commit is contained in:
Waldir Leoncio 2020-06-24 11:48:23 +02:00
parent 8e93e6305e
commit 6b36b5c843
7 changed files with 42 additions and 3 deletions

View file

@ -1,7 +1,9 @@
#' @title Clustering of individuals
#' @param tietue Record
#' @param tietue File
#' @param format Format of the data ("BAPS", "GenePop" or "Preprocessed")
#' @param savePreProcessed Save the pre-processed data?
#' @param filePreProcessed Is the file already processed?
#' @importFrom utils read.delim
#' @export
greedyMix <- function(
tietue,
@ -51,7 +53,9 @@ greedyMix <- function(
stop('Invalid alternative')
} else if (input_type_name == 'BAPS-format') {
if (!is(tietue, "character")) {
pathname_filename <- uigetfile("*.txt", "Loaddata in BAPS-format")
pathname_filename <- uigetfile(
"*.txt", "Load data in BAPS-format"
)
} else {
pathname_filename <- tietue
}

View file

@ -1,4 +1,5 @@
#' @title Tests GenePop data
#' @param tiedostonNimi Filename
testaaGenePopData <- function(tiedostonNimi) {
# kunnossa == 0, jos data ei ole kelvollinen genePop data.
# Muussa tapauksessa kunnossa == 1.