
YARM is simply a series of subroutines written in the PERL scripting language
that allow you to perform various calculations that may be useful for people
interested in NMR relaxation and biomolecular structure.
<p>

The nomenclature of the YARM subroutines uses the "verbNoun" structure, in which 
the verb describes what will be done to the Noun.  There are 6 main verbs in 
YARM:
<p>
1. <i><b>&read</b>Noun</i>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;
-Subroutines with the &read prefix handle all YARM file input (reading).
<br>
&nbsp;&nbsp;&nbsp;&nbsp;
-For example, <b>&readPDB</b> is used to read in a PDB file.
<p>

2. <i><b>&write</b>Noun</i>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;
-Subroutines with the write prefix handle all YARM file output (writing).
<br>
&nbsp;&nbsp;&nbsp;&nbsp;
-For example, <b>&writePDB</b> is used to write out structure coordinates
to a PDB file.
<p>

3. <i><b>&calc</b>Noun</i>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;
-Subroutines with the calc prefix perform a "Noun" calculation on the passed objects.
<br>
&nbsp;&nbsp;&nbsp;&nbsp;
-For example, <b>&calcSpecDens</b> is used calculate spectral densities.
<p>

4. <i><b>&sort</b>Noun:</i>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;
-Subroutines with the sort prefix sorts a "Noun"-type list.
<br>
&nbsp;&nbsp;&nbsp;&nbsp;
-For example, <b>&sortAtoms</b> is used to sort a list of atom names.
<p>

You can see a complete list of YARM subroutines 
grouped according to the of action they perform.

