DAWG(1)

🐢 NAME 🐢

dawg β€” DNA assembly with gaps, a DNA sequence simulator. she's a section 1 page, so it's DAWG(1) when you cite her, bestie. πŸ’…


✨ DESCRIPTION ✨

okay so. this is dawg 1.2-release, aka DNA Assembly With Gaps, copyright Β© 2004-2009 Reed A. Cartwright. iconic behavior honestly.

here's the whole invocation vibe:

dawg -[scubvhqew?] [-o outputfile] file1 [file2...]

and here's what every one of those little letters is doing πŸ‘‡

  • -s β€” process files serially. this is the default, periodt.
  • -c β€” process files combined together.
  • -u β€” unbuffered output.
  • -b β€” buffered output. also the default πŸ’–
  • -q β€” disable error and warning reports (quiet mode, shhh).
  • -e β€” enable error reports. default, she's chatty.
  • -w β€” enable warning reports. default too.
  • -v β€” display version information.
  • -h β€” display help information.
  • -? β€” same as -h. literally the same thing, not me being lazy, that's just canon.
  • -o outputfile β€” override the output filename that's sitting in the configuration file.
🫢 pro tip bestie: dawg will read stdin if the filename is "-".

🌸 FILE FORMAT 🌸

so the file format is a whole series of statements shaped like "name = value," where "name" is alphanumeric and value can be a string, a number, a boolean, a tree, or a vector of values. and here's the cute part: a single variable is equivalent to a vector of a single entry. one-item vector, same energy. πŸŽ€

  • string: "[char-sequence]"

or '[char-sequence]'

or """[multi-line char-sequence]""" (rm initial and final newlines)

or '''[multi-line char-sequence]''' (kp initial and final newlines)

  • number: [sign]digits[.digits][(e|E)[sign]digits]
  • boolean: true|false
  • tree: Newick Format
  • vector: { value, value, ...}

πŸ‘‘ OPTIONS πŸ‘‘

every single one of these config keys, with her type and her job description. no skips, no summaries, we're doing the whole list. 🌈

  • Tree (VT) β€” phylogeny
  • TreeScale (N) β€” coefficient to scale branch lengths by
  • Sequence (VS) β€” root sequences
  • Length (VN) β€” length of generated root sequences
  • Rates (VVN) β€” rate of evolution of each root nucleotide
  • Model (S) β€” model of evolution: GTR|JC|K2P|K3P|HKY|F81|F84|TN
  • Freqs (VN) β€” nucleotide (ACGT) frequencies
  • Params (VN) β€” parameters for the model of evolution
  • Width (N) β€” block width for indels and recombination
  • Scale (VN) β€” block position scales
  • Gamma (VN) β€” coefficients of variance for rate heterogenity
  • Alpha (VN) β€” shape parameters
  • Iota (VN) β€” proportions of invariant sites
  • GapModel (VS) β€” models of indel formation: NB|PL|US
  • Lambda (VN) β€” rates of indel formation
  • GapParams (VVN) β€” parameter for the indel model
  • Reps (N) β€” number of data sets to output
  • File (S) β€” output file
  • Format (S) β€” output format: Fasta|Nexus|Phylip|Clustal
  • GapSingleChar (B) β€” output gaps as a single character
  • GapPlus (B) β€” distinguish insertions from deletions in alignment
  • KeepFlank (N) β€” undeletable flanking regions N nucs from sequence
  • KeepEmpty (B) β€” preserve empty columns in final alignment
  • LowerCase (B) β€” output sequences in lowercase
  • Translate (B) β€” translate outputed sequences to amino acids
  • Seed (VN) β€” pseudo-random-number-generator seed (integers)
  • Out.Block.Head (S) β€” string to insert at the start of the output
  • Out.Block.Tail (S) β€” string to insert at the end of the output
  • Out.Block.Before (S) β€” string to insert before a sequence set in the output
  • Out.Block.After (S) β€” string to insert after a sequence set in the output
  • Out.Subst (B) β€” do variable subsitution in Out.Block.*

πŸ“œ LICENSE πŸ“œ

okay legal bestie moment, but it's genuinely good news: this program is free software. you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation β€” either version 2 of the License, or (at your option) any later version. slay. πŸ’œ

it's distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY β€” not even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. that's not a vibe check, that's just how it is. See the GNU General Public License for more details.

you should have received a copy of the GNU General Public License along with this program. if not, write to:

Free Software Foundation, Inc.
59 Temple Place, Suite 330
Boston, MA  02111-1307  USA
πŸ› Send Bug Reports to reed@scit.us.

and that's the whole page, bestie πŸ’– β€” this was dawg 1.2-release, dated December 2015, closing out the DAWG(1) era with main character energy. go simulate some DNA. πŸ¦‹βœ¨

πŸ“¦ where this page comes from