pcntoolkit.dataio.data_factory
==============================

.. py:module:: pcntoolkit.dataio.data_factory


Functions
---------

.. autoapisummary::

   pcntoolkit.dataio.data_factory.load_fcon1000
   pcntoolkit.dataio.data_factory.load_lifespan_big


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

.. py:function:: load_fcon1000(save_path: str | None = None)

   Download and save fcon dataset to specified path, or load it from there
   if it is already downloaded

   :param save_path: The path to save the dataset to, or load it from if it is already
                     downloaded
   :type save_path: :py:class:`str | None`

   :returns: The loaded dataset as a NormData object
   :rtype: :py:class:`NormData`


.. py:function:: load_lifespan_big(n_response_vars: int | None = None, n_largest_sites: int | None = None, n_subjects: int | None = None) -> pcntoolkit.dataio.norm_data.NormData

   Load the lifespan_big dataset, which is a large lifespan dataset with many sites.

   :param n_response_vars: If specified, only use the first n_response_vars response
                           variables.
   :type n_response_vars: :py:class:`int | None`
   :param n_largest_sites: If specified, only keep data from the n_largest_sites largest
                           sites.
   :type n_largest_sites: :py:class:`int | None`
   :param n_subjects: If specified, randomly sample n_subjects subjects.
   :type n_subjects: :py:class:`int | None`

   :returns: The loaded dataset as a NormData object.
   :rtype: :py:class:`NormData`