Class: Bio::PhyloXML::Reference

Inherits:

Object

• Object
• Bio::PhyloXML::Reference

Defined in:

lib/bio-phyloxml/phyloxml_elements.rb

Overview

Description

A literature reference for a clade. It is recommended to use the ‘doi’ attribute instead of the free text ‘desc’ element whenever possible.

Instance Attribute Summary

• #desc ⇒ Object

  String.

• #doi ⇒ Object

  String.

Instance Method Summary

• #to_xml ⇒ Object

  Converts elements to xml representation.

Instance Attribute Details

#desc ⇒ Object

String. Free text description.

# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 985

def desc
  @desc
end

#doi ⇒ Object

String. Digital Object Identifier.

# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 982

def doi
  @doi
end

Instance Method Details

#to_xml ⇒ Object

Converts elements to xml representation. Called by PhyloXML::Writer class.

# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 988

def to_xml
  ref = LibXML::XML::Node.new('reference')
  Writer.generate_xml(ref, self, [
        [:attr, 'doi'],
        [:simple, 'desc', (defined? @desc) ? @desc : nil]])
   return ref
end