Nothing
#' Converts a genlight object to STRUCTURE formatted files
#'
#' This function exports genlight objects to STRUCTURE formatted files (be aware
#' there is a gl2faststructure version as well). It is based on the code
#' provided by Lindsay Clark (see
#' \url{https://github.com/lvclark/R_genetics_conv}) and this function is
#' basically a wrapper around her numeric2structure function. See also: Lindsay
#' Clark. (2017, August 22). lvclark/R_genetics_conv: R_genetics_conv 1.1
#' (Version v1.1). Zenodo: doi.org/10.5281/zenodo.846816.
#'
#' @param x Name of the genlight object containing the SNP data and location
#' data, lat longs [required].
#' @param indNames Specify individuals names to be added
#' [if NULL, defaults to indNames(x)].
#' @param addcolumns Additional columns to be added before genotypes
#' [default NULL].
#' @param ploidy Set the ploidy [defaults 2].
#' @param exportMarkerNames If TRUE, locus names locNames(x) will be included
#' [default TRUE].
#' @param outfile File name of the output file (including extension)
#' [default "gl.str"].
#' @param outpath Path where to save the output file
#' [default tempdir(), mandated by CRAN]. Use outpath=getwd() or outpath='.'
#' when calling this function to direct output files to your working directory.
#' @param verbose Verbosity: 0, silent or fatal errors; 1, begin and end; 2,
#' progress log; 3, progress and results summary; 5, full report
#' [default 2 or as specified using gl.set.verbosity].
#' @return returns no value (i.e. NULL)
#' @export
#' @author Bernd Gruber (wrapper) and Lindsay V. Clark [lvclark@illinois.edu]
#' @examples
#' #not run here
#' #gl2structure(testset.gl)
gl2structure <- function(x,
indNames = NULL,
addcolumns = NULL,
ploidy = 2,
exportMarkerNames = TRUE,
outfile = "gl.str",
outpath = tempdir(),
verbose = NULL) {
outfilespec <- file.path(outpath, outfile)
# SET VERBOSITY
verbose <- gl.check.verbosity(verbose)
# FLAG SCRIPT START
funname <- match.call()[[1]]
utils.flag.start(func = funname,
build = "Jody",
verbosity = verbose)
# CHECK DATATYPE
datatype <- utils.check.datatype(x, verbose = verbose)
# FUNCTION SPECIFIC ERROR CHECKING
nInd <- nInd(x)
if (is.null(indNames)) {
indNames <-indNames(x)
}
if (length(indNames) != nInd) {
stop(
error(
"Fatal Error: No. of individuals listed in user-specified indNames and no. of individuals in supplied genlight object x do not match\n"
)
)
}
if (!is.null(addcolumns) && is.null(dim(addcolumns))) {
addcolumns <- data.frame(pop = addcolumns)
}
if (!is.null(addcolumns) && nrow(addcolumns) != nInd) {
stop(
error(
"Fatal Error: No. of individuals in user-specified addColumns and no. of individuals in supplied genlight object x does not match\n"
)
)
}
genmat <- as.matrix(x)
if (!all(genmat %in% c(0:ploidy, NA))) {
stop(error(
"Fatal Error: genmat must only contain 0, 1, 2... ploidy and NA\n"
))
}
if (length(outfile) != 1 || !is.character(outfile)) {
stop(error(
"Fatal Error: output file must be a single character string\n"
))
}
if (length(ploidy) != 1 || !is.numeric(ploidy)) {
stop(error("Fatal Error: ploidy must be a single number\n"))
}
if (!exportMarkerNames %in% c(TRUE, FALSE)) {
stop(error("Fatal Error: exportMarkerNames must be TRUE or FALSE\n"))
}
# DO THE JOB
# make sets of possible genotypes
G <- list()
for (i in 0:ploidy) {
G[[i + 1]] <- c(rep(1, ploidy - i), rep(2, i))
}
G[[ploidy + 2]] <- rep(-9, ploidy) # for missing data
# set up data frame for Structure
StructTab <- data.frame(ind = rep(indNames, each = ploidy))
# add any additional columns
if (!is.null(addcolumns)) {
for (i in 1:dim(addcolumns)[2]) {
StructTab <-
data.frame(StructTab, rep(addcolumns[, i], each = ploidy))
if (!is.null(dimnames(addcolumns)[[2]])) {
names(StructTab)[i + 1] <- dimnames(addcolumns)[[2]][i]
} else {
names(StructTab)[i + 1] <- paste("X", i, sep = "")
}
}
}
# add genetic data
for (i in 1:dim(genmat)[2]) {
thesegen <- genmat[, i] + 1
thesegen[is.na(thesegen)] <- ploidy + 2
StructTab[[dimnames(genmat)[[2]][i]]] <-
unlist(G[thesegen])
}
# add marker name header
if (exportMarkerNames) {
cat(paste(locNames(x), collapse = "\t"),
sep = "\n",
file = outfilespec)
}
# export all data
if (grepl("unix", .Platform$OS.type, ignore.case = TRUE)) {
write.table(
StructTab,
row.names = FALSE,
col.names = FALSE,
append = TRUE,
sep = "\t",
file = outfilespec,
quote = FALSE
)
}else{
write.table(
StructTab,
row.names = FALSE,
col.names = FALSE,
append = TRUE,
sep = "\t",
eol = "\r\n",
file = outfilespec,
quote = FALSE
)
}
if (verbose >= 2) {
cat(report(paste(
" Structure file saved as:", outfilespec,"\n"
)))
}
# FLAG SCRIPT END
if (verbose > 0) {
cat(report("Completed:", funname, "\n"))
}
return(NULL)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.