spirepy.study
=============

.. py:module:: spirepy.study


Classes
-------

.. autoapisummary::

   spirepy.study.Study


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

.. py:class:: Study(name: str)

   A study from SPIRE.

   This class represents a study from the SPIRE database. It automatically
   fetches metadata and automates the initialization of samples to further use
   to obtain its genomic, geographical or other types of data provided by it.

   :param name: Internal ID for the study.
   :type name: str


   .. py:attribute:: name


   .. py:method:: get_metadata() -> polars.DataFrame

      Retrieve metadata for the study.

      :return: A Dataframe with the study's metadata.
      :rtype: :class:`polars.DataFrame`



   .. py:method:: get_samples() -> list

      Retrive a list of samples for the study.

      :return: List of :class:`spirepy.sample.Sample` that belong to the study.
      :rtype: list



   .. py:method:: get_mags() -> polars.DataFrame

      Get a DataFrame with information regarding the MAGs.

      :return: A Dataframe with the study's MAGs.
      :rtype: :class:`polars.DataFrame`



   .. py:method:: download_assemblies(output: str)

      Download the assemblies into a specified folder.

      :param output: Output folder to download the assemblies to.
      :type output: str



   .. py:method:: download_mags(output: str)

      Download the MAGs into a specified folder.

      :param output: Output folder to download the MAGs to.
      :type output: str



   .. py:method:: download_genecalls(output: str)

      Download the genecalls into a specified folder.

      :param output: Output folder to download the genecalls to.
      :type output: str



   .. py:method:: download_proteins(output: str)

      Download the proteins into a specified folder.

      :param output: Output folder to download the proteins to.
      :type output: str