Add optional comments

seqreport/SeqCollection.py

@@ -21,6 +21,9 @@ class SeqCollection:
 
  **projectname**
  > The name of the project (`str`).
+
+ **comments**
+ > Any comments to be included in the report (`str`).
  """
 
  def __init__(
@@ -30,6 +33,7 @@ def __init__(
  cost_per_seq=0,
  currency_symbol="£",
  projectname="",
+ comments="",
  ):
  self.fasta = fasta
  self.cost_per_base = cost_per_base
@@ -45,3 +49,4 @@ def __init__(
  self.n_bp = n_bp
  self.cost = self.n_seq * self.cost_per_seq + self.n_bp * self.cost_per_base
  self.projectname = projectname
+ self.comments = comments

seqreport/report_assets/seq_report.pug

@@ -10,7 +10,7 @@ hr
 p.
  This document reports basic sequence statistics.
 
-if seqcollection.projectname 
+if seqcollection.projectname
  p.
  Projectname: <b>{{ seqcollection.projectname }}</b>
 
@@ -21,6 +21,9 @@ p.
 p.
  Estimated cost: <b>{{ seqcollection.currency_symbol }} {{ seqcollection.cost }}</b>
 
+if seqcollection.comments
+ p.
+ Comments: <i>{{ seqcollection.comments }}</i>
 
 div(style="margin-top:1cm; margin-bottom:1cm;")
 

tests/test_SeqCollection.py

@@ -7,7 +7,10 @@
 
 
 def test_SeqCollection(tmpdir):
- seq_coll = seqreport.SeqCollection(fasta=seq_fasta, projectname="EGF24")
+ seq_coll = seqreport.SeqCollection(
+ fasta=seq_fasta, projectname="EGF24", comments="This is a test sequence set."
+ )
  assert seq_coll.n_seq == 3
  assert seq_coll.n_bp == 99
  assert seq_coll.projectname == "EGF24"
+ assert seq_coll != ""