Skip to content

cayek/TESS3

Repository files navigation

This project is no longer supported. Please consider this repository instead:

https://github.com/BioShock38/TESS3_encho_sen

TESS3

TESS3 is a fast and efficient program for estimating spatial population structure based on geographically constrained non-negative matrix factorization and population genetics.

TESS3 can be used on Mac, Linux or Windows through the command-line interface or in R software environment thanks to the R package.

The R package is in development, you can only download the Beta release.

TESS3 Command-line software

Command-line software installation

We provide cmake file to compile the command-line software code. You need to download the master source directory here.

The first step is to generate compilation build environment to compile source code using cmake (can be install here).

  • On Linux or Mac OS, in TESS3 directory use these bash commands to generate makefile:
    mkdir build/
	cd build
	cmake -DCMAKE_BUILD_TYPE=release ../
  • On windows, you can use cmake to generate visual studio project or MinGW Makefiles (GNU compilers and make can be install using MinGW installer)

Then, you can build the program.

  • On Linux or Mac OS, in TESS3 directory:
    cd build/
	make TESS3

Command-line software documentation

The Command-line program documentation is available here.

tess3r R package

Beta release !

R package installation

You can install the R package directly from the github repository thanks to the package devtools. If you don't already have devtools R package you can install it from CRAN. In a R session paste this command:

install.packages("devtools")

Then, you can install the package. In a R session paste this command:

devtools::install_github("cayek/TESS3/tess3r")

R package documentation

The R package documentation is available here.

R package tutorials.

Organization

The repository is organized as follows:

  • tess3r: code source of the program.

  • external: external libraries.

  • test: scripts to test the program (for developers only).

  • doc: program documentation.

  • data: simulated data sets provided for examples.