.. include:: substitutions
.. include:: ../apps-substitutions

.. _chapter_checkcff:

************
CheckCff
************

.. program:: checkcff

========
Overview
========

This is a simple utility that will simply apply a color force field to
one or more input molecules and output a report of color atoms added,
the TYPE of the added atom and the corresponding input molecule atoms
that matched the SMARTS defining that TYPE. Additionally,
:command:`checkcff` will output an OEB file containing molecules with
the color atoms added. This file can be loaded into VIDA and the atoms
labeled with *Name* to visually inspect which color atoms are
being added.

======================
Example Commands
======================

By default, :command:`checkcff` will use the ImplicitMillsDean color force
field. This can be over-ridden by using the :option:`-chemff` option and
providing either a name of one of the built-in color force fields
(ImplicitMillsDean, ExplicitMillsDean, ImplicitMillsDeanNoRings, ExplicitMillsDeanNoRings) or the name of a user-defined
color force field file.

So to see which atoms are considered color atoms using the ImplicitMillsDean
force field:


.. code-block:: bash

  prompt> checkcff -in mymolecules.sdf

To use the ExplicitMillsDean force field to see which atoms are considered 
to be color atoms:

.. code-block:: bash

  prompt> checkcff -in molecules.sdf -chemff ExplicitMillsDean

The run always generates a report CSV file and an OEB file that can be viewed in VIDA:

.. code-block:: bash

  prompt> checkcff -in 4cox-neutral.sdf


And the view in **VIDA** might look a bit like:

.. figure:: images/checkcff.png
   :scale: 75
   :align: center
   :alt: VIDA view of molecule with color atoms.

   **VIDA** view of 4COX with color atoms attached and labeled.

====================
Command Line Help
====================

A description of the command line interface can be obtained by executing **CheckCff**
with the `--help` option.

.. code-block:: console
   
   > checkcff --help

will generate the following output:

::

   Help functions:
     checkcff --help simple      : Get a list of simple parameters
     checkcff --help all         : Get a complete list of parameters
     checkcff --help defaults    : List the defaults for all parameters
     checkcff --help <parameter> : Get detailed help on a parameter
     checkcff --help html        : Create an html help file for this program
     checkcff --help versions    : List the toolkits and versions used in the application

======================
Required Parameters 
======================

:command:`checkcff` only has 1 required commandline parameter.

.. option:: -in <filename>


  Input molecule file to be colored. Can be any one of the molecule
  file formats described in Section :ref:`queryfile`.

======================
Optional Parameters 
======================
  [Aliases=**-i**]

.. option:: -out <oebfile>


  Output OEB file name for 3D structures with color atoms named
  by the TYPE from the color force field. 

  [Default=checkcff.oeb]
  [Aliases=**-o**]

.. option:: -report <csvfile>

  Override prefix used to name report file. 

  [Default=checkcff_rpt.csv]

.. include:: ../common/file_options.irst
.. include:: ../common/progress_options.irst

Overlap Prep Option Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There are 6 overlap prep option parameters.

.. option:: -chemff <cff_file>

  Color-force-field name. Either the name of one of the built-in color
  force fields (ImplicitMillsDean or ExplicitMillsDean or ImplicitMillsDeanNoRings or ExplicitMillsDeanNoRings) 
  or the name of a user-defined color force field file. The format of this file is
  given in section :ref:`colorforcefield`.  

  [Default=ImplicitMillsDean]

.. option:: -assignColor

  Determines the state of the assign color flag. If true, color atoms would be 
  assigned during the :ref:`Prep<OEShape_OEOverlapPrep_Prep>`.

  [Default=true]

.. option:: -useHydrogens 

  Determines the state of the use hydrogens flag. If true, explicit hydrogens atoms would be 
  created during the :ref:`Prep<OEShape_OEOverlapPrep_Prep>`. If false, all hydrogen
  atoms would be removed.

  [Default=false]

.. option:: -assignBondiRadii

  Determines the state of the assign Bondi radii flag. If true, Bondi radii 
  would be assigned to all the atom during the :ref:`Prep<OEShape_OEOverlapPrep_Prep>`.

  [Default=false]

.. option:: -removeDups

  Determines if close color atoms with the distance less than `-minDistance`
  should be removed. 

  [Default=false]

.. option:: -minDistance

  Threshold for duplicate removal. A value in the interval (0,1) that determines the minimum
  allowed distance between two color atoms.

  [Default=0.001]