Getting started with tinselR
tinselR (pronounced tinsel-er) at its' most basic level is a graphical viewer of newick phylogenetic trees and as a program for producing publication-ready figures. The power of tinselR comes with combining a genetic distance matrix for annotating a tree for epidemological outbreak analyses. A genetic distance matrix contains the number of snp differences for all pairwise comparisons. Note that the data you upload is only held within the application while launched (i.e. no data is stored.) When you are happy with the way your tree looks scroll to the bottom and press Download.
If there is a bug, feature request, or documentation needed, please file an issue
Data Upload
Please click on the 'Data Upload' tab to upload your files. Alternatively, take a look at the 'Example Data' tab to test out the application. A brief description about the example data is provided in the About the Example Data tab.
There is only one differences between the 'Example Data' and the 'Data Upload' tabs: the 'Example Data' tab has pre-loaded data, while the 'Data Upload' tab is where you, the user, can upload your own files (i.e. phylogenetic tree, genetic distance file, and metadata file). By that we mean, in the 'Example Data' tab, the user only has three options to select from - example data 1, example data 2, and example data 3 - displayed in one drop down menu. While in the 'Data Upload' tab, there are three drop down menus - 1) tree upload, 2) genetic upload, and 3) meta upload.
Both 'Example Data' and 'Data Upload' tabs provide error messages as a user either uploads all three files or selects a data set. Types of file checks that occur inform the user of the correctly selected delimiter, if the tips are concordant across all three files, or if there is a column to use the add heatmap functionality. This file checking happens independently of if the user wants the information. By that, we mean a user can ignore the file check messages if they do not need them and proceed using the application.
Beyond that the application is exactly the same between user and example data, thus this is why we highly encourage users to play with the example data first just to familiarize yourself with the application. Below we describe the three types of data files and what can be done within the application to alter your tree image after they have been uploaded.
Data files to upload
A tsv/txt/csv file of SNP differences. See image below for example.
a tsv/txt/csv file - requires column headers of Display.labels and Tip.labels for easy change of tip labels, while the heatmap column may be titled whatever you decide. See image below for example.