
.. _fred_opt_params:

.. program:: fred

======================
Optional Parameters
======================

Input Options
--------------

.. include:: ../common_flags/flag_param.rstinc

.. include:: ../common_flags/flag_molnames.rstinc

Dock Options
------------

.. include:: ../common_flags/flag_dock_resolution.rstinc

Output File
-----------

.. option:: -docked_molecule_file <filename> [Default=docked.oeb.gz]

   File docked molecules will be written to.  The file format is
   controlled by the extension of the filename.  The following output
   formats are supported.

   ================ ===========================
   Format           Extension
   ================ ===========================
   OEBinary         .oeb
   ---------------- ---------------------------
   SDF              .sdf
   ---------------- ---------------------------
   Gzipped OEBinary .oeb.gz
   ---------------- ---------------------------
   Gzipped SDF      .sdf.gz
   ================ ===========================

   Scores will be attached as SD data to each pose with the tag
   *FRED Chemgauss4 Score*, unless the :option:`-score_tag` option is used
   to specify another tag.

   The number of top scoring molecules outputted is controlled by the
   :option:`-hitlist_size` option (which has a default value of 500).

   .. note::

      If this flag is not set by the user the default filename (i.e., docked.oeb.gz)
      will be automatically prefixed with the setting of the
      :option:`-prefix` flag.

   [Aliases=**-docked_mol_file**,**-docked_file**,**-docked**,**-out**]

.. include:: ../common_flags/flag_undocked_molecule_file.rstinc

.. include:: ../common_flags/flag_score_file.rstinc

.. include:: ../common_flags/flag_report_file.rstinc

.. include:: ../common_flags/flag_settings_file.rstinc

.. include:: ../common_flags/flag_status_file.rstinc

Output Options
--------------

.. include:: ../common_flags/flag_hitlist_size.rstinc

.. include:: ../common_flags/flag_num_poses.rstinc

.. option:: -score_tag <score tag> [No Default]

   This parameter overrides the default SD data tag used to store molecule
   scores.

   [Aliases=**-scoretag**]

.. include:: ../common_flags/flag_annotate_scores.rstinc

.. include:: ../common_flags/flag_save_component_scores.rstinc

.. option:: -no_extra_output_files [Default=false]

    When this flag is set to true the only default output to the program will be
    the docked structure file (see :option:`-docked_molecule_file`).

    Using this flag suppresses the default output of the following

    ====================== =============== ===================================
    Output                 Default         Parameter
    filename
    ====================== =============== ===================================
    Undocked molecule file undocked.oeb.gz :option:`-undocked_molecule_file`
    ---------------------- --------------- -----------------------------------
    Text score file        score.txt       :option:`-score_file`
    ---------------------- --------------- -----------------------------------
    Report file            report.txt      :option:`-report_file`
    ---------------------- --------------- -----------------------------------
    Settings file          fred.param      :option:`-settings_file`
    ---------------------- --------------- -----------------------------------
    Status file            status.txt      :option:`-status_file`
    ====================== =============== ===================================

    Only default output is suppressed.  If any of these output parameters are
    explicitly set by the users the relevant output file will still be written
    even if this switch is turned on.

   [Aliases=**-no_extra**,**-noextra**,**-noextraoutputfiles**,**-no_extra_output**,**-noextraoutput**]

.. include:: ../common_flags/flag_no_dots.rstinc

.. option:: -prefix <value> [Default=fred]

   This flag prefixes all default output filenames with the specified value.

   .. note::

      This flag does not affect output filenames explicitly set by the user.

.. option:: -nostructs [Default=false]

   When this flag is set to true, both the docked and undocked structure files
   will be suppressed. The flag overrides :option:`-docked_molecule_file` and
   :option:`-undocked_molecule_file`.
