Skip to content

Sequence ID Mapping

Parts of a SEGUL commandThe command segul sequence id --dir alignments/ --map has five parts: the program segul, the command sequence for the task group, the subcommand id for the task, the input --dir alignments/ (folder or files), and the option --map (ID map).segulProgramsequenceCommandtask groupidSubcommandtask--dir alignments/Inputfolder or files--mapOptionsID map

To map the distribution of your samples across your dataset, you only need to pass --map flag in the finding unique IDs command:

Terminal window
segul sequence id -i [input-path] --map

It will generate two files, saved to Sequence-ID by default. The first file is the list of unique IDs in your dataset (named default to id.txt). This file is similar to generating unique IDs. The second file is a CSV file (named default to map.csv) containing the distribution of your samples presented in true/false values across your alignments. The content of the file will look like as below:

locussequence_1sequence_2sequence_3
locus_1truefalsetrue
locus_2truetruetrue
locus_3falsefalsetrue

To change the output directory, use the -o or --output option:

Terminal window
segul sequence id -d alignments/ --map -o my_alignment_id

To change the output file name, use the --prefix option:

Terminal window
segul sequence id -d alignments/ --map --prefix my_alignment_id
OptionDescription
-d, --dirDirectory with alignments
-i, --inputAlignment files. Allows wildcards
-f, --input-formatInput format: auto (default), fasta, nexus, or phylip
--datatypeData type: dna (default), aa, or ignore
--mapAlso write the presence of each ID in each alignment
-o, --outputOutput directory. Default: Sequence-ID
-p, --prefixPrefix of the output files
--forceOverwrite an existing output directory
--logLog file path. Default: segul.log

This material is based upon work supported by the National Science Foundation under grant numbers: DEB-1754393 and DEB-2244754. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the National Science Foundation.