.. include:: ../../toolkit-substitutions

.. oe:namespace:: OESpruce

..  _OESpruce_OEMutateResidues:

.. oe:function:: OEMutateResidues

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMutateResidues(OEChem::OEMolBase& mol,
                               const std::map<OEChem::OEResidue, std::string>& mutationMap,
                               const OESpruce::OESidechainBuilderOptions& opts = OESpruce::OESidechainBuilderOptions(true))

   .. oe:language:: python

      .. oe:api:: python

         OEMutateResidues(mol: Union[OEGraphMol,OEMol,OEQMol],
                          mutationMap: mapOEResidueString,
                          opts: OESidechainBuilderOptions = OESidechainBuilderOptions(true)) -> bool

   This function takes an input :ref:`OEMolBase <OEChem_OEMolBase>` (`mol`) and it mutates residues in the provided map. The sidechain re-building
   can be controlled using the :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` options class argument `opts`.

   .. oe:api: IGNORE

      bool OEMutateResidues(OEBio::OEDesignUnit& mol,
                             const std::map<OEChem::OEResidue, std::string>& mutationMap,
                             const OESpruce::OESidechainBuilderOptions& opts=OESpruce::OESidechainBuilderOptions(true));

   .. seealso::

      * :oe:func:`OESpruce::OEBuildSidechains` function
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
