Exporting importFile()

NAMESPACE

@@ -2,6 +2,7 @@
 
 export(greedyMix)
 export(handleData)
+export(importFile)
 export(load_fasta)
 importFrom(R6,R6Class)
 importFrom(Rsamtools,scanBam)

R/importFile.R

@@ -1,3 +1,14 @@
+#' @title Import data file
+#' @description Imports data from several formats (FASTA, VCF, SAM, BAM,
+#' Genepop).
+#' @param data raw dataset
+#' @param format data format (guesses from extension if not provided)
+#' @param verbose if \code{TRUE}, prints extra output information
+#' @return The data in a format that can be used by the other functions
+#' @export
+#' @examples
+#' path_inst <- system.file("extdata", "", package = "rBAPS")
+#' importFile(file.path(path_inst, "FASTA_clustering_haploid.fasta"))
 importFile <- function(data, format, verbose) {
   # Parsing data format ------------------------------------------------------
 

man/importFile.Rd

@@ -0,0 +1,26 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/importFile.R
+\name{importFile}
+\alias{importFile}
+\title{Import data file}
+\usage{
+importFile(data, format, verbose)
+}
+\arguments{
+\item{data}{raw dataset}
+
+\item{format}{data format (guesses from extension if not provided)}
+
+\item{verbose}{if \code{TRUE}, prints extra output information}
+}
+\value{
+The data in a format that can be used by the other functions
+}
+\description{
+Imports data from several formats (FASTA, VCF, SAM, BAM,
+Genepop).
+}
+\examples{
+path_inst <- system.file("extdata", "", package = "rBAPS")
+importFile(file.path(path_inst, "FASTA_clustering_haploid.fasta"))
+}