:py:mod:`deeprvat.deeprvat.config`
==================================

.. py:module:: deeprvat.deeprvat.config

.. autodoc2-docstring:: deeprvat.deeprvat.config
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`cli <deeprvat.deeprvat.config.cli>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.cli
          :summary:
   * - :py:obj:`setup_logging <deeprvat.deeprvat.config.setup_logging>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.setup_logging
          :summary:
   * - :py:obj:`load_yaml <deeprvat.deeprvat.config.load_yaml>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.load_yaml
          :summary:
   * - :py:obj:`update_defaults <deeprvat.deeprvat.config.update_defaults>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.update_defaults
          :summary:
   * - :py:obj:`handle_cv_options <deeprvat.deeprvat.config.handle_cv_options>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.handle_cv_options
          :summary:
   * - :py:obj:`handle_regenie_options <deeprvat.deeprvat.config.handle_regenie_options>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.handle_regenie_options
          :summary:
   * - :py:obj:`handle_pretrained_models <deeprvat.deeprvat.config.handle_pretrained_models>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.handle_pretrained_models
          :summary:
   * - :py:obj:`update_thresholds <deeprvat.deeprvat.config.update_thresholds>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.update_thresholds
          :summary:
   * - :py:obj:`update_full_config <deeprvat.deeprvat.config.update_full_config>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.update_full_config
          :summary:
   * - :py:obj:`validate_keys <deeprvat.deeprvat.config.validate_keys>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.validate_keys
          :summary:
   * - :py:obj:`create_main_config <deeprvat.deeprvat.config.create_main_config>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.create_main_config
          :summary:
   * - :py:obj:`create_sg_discovery_config <deeprvat.deeprvat.config.create_sg_discovery_config>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.create_sg_discovery_config
          :summary:
   * - :py:obj:`update_config <deeprvat.deeprvat.config.update_config>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.update_config
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`REPO_DIR <deeprvat.deeprvat.config.REPO_DIR>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.REPO_DIR
          :summary:
   * - :py:obj:`logger <deeprvat.deeprvat.config.logger>`
     - .. autodoc2-docstring:: deeprvat.deeprvat.config.logger
          :summary:

API
~~~

.. py:data:: REPO_DIR
   :canonical: deeprvat.deeprvat.config.REPO_DIR
   :value: 'resolve(...)'

   .. autodoc2-docstring:: deeprvat.deeprvat.config.REPO_DIR

.. py:data:: logger
   :canonical: deeprvat.deeprvat.config.logger
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: deeprvat.deeprvat.config.logger

.. py:function:: cli()
   :canonical: deeprvat.deeprvat.config.cli

   .. autodoc2-docstring:: deeprvat.deeprvat.config.cli

.. py:function:: setup_logging(log_filename: str = 'config_generate.log')
   :canonical: deeprvat.deeprvat.config.setup_logging

   .. autodoc2-docstring:: deeprvat.deeprvat.config.setup_logging

.. py:function:: load_yaml(file_path: str)
   :canonical: deeprvat.deeprvat.config.load_yaml

   .. autodoc2-docstring:: deeprvat.deeprvat.config.load_yaml

.. py:function:: update_defaults(base_config, input_config)
   :canonical: deeprvat.deeprvat.config.update_defaults

   .. autodoc2-docstring:: deeprvat.deeprvat.config.update_defaults

.. py:function:: handle_cv_options(input_config, full_config, expected_input_keys)
   :canonical: deeprvat.deeprvat.config.handle_cv_options

   .. autodoc2-docstring:: deeprvat.deeprvat.config.handle_cv_options

.. py:function:: handle_regenie_options(input_config, full_config, expected_input_keys)
   :canonical: deeprvat.deeprvat.config.handle_regenie_options

   .. autodoc2-docstring:: deeprvat.deeprvat.config.handle_regenie_options

.. py:function:: handle_pretrained_models(input_config, expected_input_keys)
   :canonical: deeprvat.deeprvat.config.handle_pretrained_models

   .. autodoc2-docstring:: deeprvat.deeprvat.config.handle_pretrained_models

.. py:function:: update_thresholds(input_config, full_config, train_only)
   :canonical: deeprvat.deeprvat.config.update_thresholds

   .. autodoc2-docstring:: deeprvat.deeprvat.config.update_thresholds

.. py:function:: update_full_config(input_config, full_config, train_only)
   :canonical: deeprvat.deeprvat.config.update_full_config

   .. autodoc2-docstring:: deeprvat.deeprvat.config.update_full_config

.. py:function:: validate_keys(input_config, expected_input_keys, optional_input_keys, base_config)
   :canonical: deeprvat.deeprvat.config.validate_keys

   .. autodoc2-docstring:: deeprvat.deeprvat.config.validate_keys

.. py:function:: create_main_config(config_file: str, output_dir: typing.Optional[str] = '.', clobber: typing.Optional[bool] = False)
   :canonical: deeprvat.deeprvat.config.create_main_config

   .. autodoc2-docstring:: deeprvat.deeprvat.config.create_main_config

.. py:function:: create_sg_discovery_config(config_file: str, output_dir: typing.Optional[str] = '.')
   :canonical: deeprvat.deeprvat.config.create_sg_discovery_config

   .. autodoc2-docstring:: deeprvat.deeprvat.config.create_sg_discovery_config

.. py:function:: update_config(association_only: bool, phenotype: typing.Optional[str], baseline_results: typing.Tuple[str], baseline_results_out: typing.Optional[str], seed_genes_out: typing.Optional[str], old_config_file: str, new_config_file: str)
   :canonical: deeprvat.deeprvat.config.update_config

   .. autodoc2-docstring:: deeprvat.deeprvat.config.update_config