tooluniverse 1.0.6__py3-none-any.whl → 1.0.8__py3-none-any.whl

tooluniverse/tools/FAERS_count_country_by_drug_event.py

@@ -0,0 +1,63 @@
+"""
+FAERS_count_country_by_drug_event
+
+Count the number of adverse event reports per country of occurrence, filtered by drug, patient de...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_country_by_drug_event(
+    medicinalproduct: str,
+    patientsex: str,
+    patientagegroup: str,
+    serious: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Count the number of adverse event reports per country of occurrence, filtered by drug, patient de...
+
+    Parameters
+    ----------
+    medicinalproduct : str
+        Drug name.
+    patientsex : str
+        Patient sex, leave it blank if you don't want to apply a filter.
+    patientagegroup : str
+        Patient age group.
+    serious : str
+        Whether the event was serious.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_country_by_drug_event",
+            "arguments": {
+                "medicinalproduct": medicinalproduct,
+                "patientsex": patientsex,
+                "patientagegroup": patientagegroup,
+                "serious": serious,
+            },
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_country_by_drug_event"]

tooluniverse/tools/FAERS_count_death_related_by_drug.py

@@ -0,0 +1,49 @@
+"""
+FAERS_count_death_related_by_drug
+
+Count adverse events associated with patient death for a given drug. Data source: FDA Adverse Eve...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_death_related_by_drug(
+    medicinalproduct: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Count adverse events associated with patient death for a given drug. Data source: FDA Adverse Eve...
+
+    Parameters
+    ----------
+    medicinalproduct : str
+        Drug name.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_death_related_by_drug",
+            "arguments": {"medicinalproduct": medicinalproduct},
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_death_related_by_drug"]

tooluniverse/tools/FAERS_count_drug_routes_by_event.py

@@ -0,0 +1,52 @@
+"""
+FAERS_count_drug_routes_by_event
+
+Count the most common routes of administration for drugs involved in adverse event reports. Data ...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_drug_routes_by_event(
+    medicinalproduct: str,
+    serious: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Count the most common routes of administration for drugs involved in adverse event reports. Data ...
+
+    Parameters
+    ----------
+    medicinalproduct : str
+        Drug name.
+    serious : str
+        Seriousness of event.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_drug_routes_by_event",
+            "arguments": {"medicinalproduct": medicinalproduct, "serious": serious},
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_drug_routes_by_event"]

tooluniverse/tools/FAERS_count_drugs_by_drug_event.py

@@ -0,0 +1,63 @@
+"""
+FAERS_count_drugs_by_drug_event
+
+Count the number of different drugs involved in FDA adverse event reports, filtered by patient de...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_drugs_by_drug_event(
+    patientsex: str,
+    patientagegroup: str,
+    occurcountry: str,
+    serious: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Count the number of different drugs involved in FDA adverse event reports, filtered by patient de...
+
+    Parameters
+    ----------
+    patientsex : str
+        Patient sex, leave it blank if you don't want to apply a filter.
+    patientagegroup : str
+        Patient age group.
+    occurcountry : str
+        Country where event occurred.
+    serious : str
+        Whether the event was serious.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_drugs_by_drug_event",
+            "arguments": {
+                "patientsex": patientsex,
+                "patientagegroup": patientagegroup,
+                "occurcountry": occurcountry,
+                "serious": serious,
+            },
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_drugs_by_drug_event"]

tooluniverse/tools/FAERS_count_outcomes_by_drug_event.py

@@ -0,0 +1,63 @@
+"""
+FAERS_count_outcomes_by_drug_event
+
+Count the outcome of adverse reactions (recovered, recovering, fatal, unresolved) filtered by dru...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_outcomes_by_drug_event(
+    medicinalproduct: str,
+    patientsex: str,
+    patientagegroup: str,
+    occurcountry: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Count the outcome of adverse reactions (recovered, recovering, fatal, unresolved) filtered by dru...
+
+    Parameters
+    ----------
+    medicinalproduct : str
+        Drug name.
+    patientsex : str
+
+    patientagegroup : str
+
+    occurcountry : str
+
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_outcomes_by_drug_event",
+            "arguments": {
+                "medicinalproduct": medicinalproduct,
+                "patientsex": patientsex,
+                "patientagegroup": patientagegroup,
+                "occurcountry": occurcountry,
+            },
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_outcomes_by_drug_event"]

tooluniverse/tools/FAERS_count_patient_age_distribution.py

@@ -0,0 +1,49 @@
+"""
+FAERS_count_patient_age_distribution
+
+Analyze the age distribution of patients experiencing adverse events for a specific drug. The age...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_patient_age_distribution(
+    medicinalproduct: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Analyze the age distribution of patients experiencing adverse events for a specific drug. The age...
+
+    Parameters
+    ----------
+    medicinalproduct : str
+        Drug name.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_patient_age_distribution",
+            "arguments": {"medicinalproduct": medicinalproduct},
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_patient_age_distribution"]

tooluniverse/tools/FAERS_count_reactions_by_drug_event.py

@@ -0,0 +1,71 @@
+"""
+FAERS_count_reactions_by_drug_event
+
+Count the number of adverse reactions reported for a given drug, filtered by patient details, eve...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_reactions_by_drug_event(
+    medicinalproduct: str,
+    patientsex: str,
+    patientagegroup: str,
+    occurcountry: str,
+    serious: str,
+    seriousnessdeath: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Count the number of adverse reactions reported for a given drug, filtered by patient details, eve...
+
+    Parameters
+    ----------
+    medicinalproduct : str
+        Drug name.
+    patientsex : str
+        Patient sex, leave it blank if you don't want to apply a filter.
+    patientagegroup : str
+        Patient age group.
+    occurcountry : str
+        Country where event occurred.
+    serious : str
+        Whether the event was serious.
+    seriousnessdeath : str
+        Was death reported?
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_reactions_by_drug_event",
+            "arguments": {
+                "medicinalproduct": medicinalproduct,
+                "patientsex": patientsex,
+                "patientagegroup": patientagegroup,
+                "occurcountry": occurcountry,
+                "serious": serious,
+                "seriousnessdeath": seriousnessdeath,
+            },
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_reactions_by_drug_event"]

tooluniverse/tools/FAERS_count_reportercountry_by_drug_event.py

@@ -0,0 +1,63 @@
+"""
+FAERS_count_reportercountry_by_drug_event
+
+Count the number of FDA adverse event reports grouped by the country of the primary reporter. Dat...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_reportercountry_by_drug_event(
+    medicinalproduct: str,
+    patientsex: str,
+    patientagegroup: str,
+    serious: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Count the number of FDA adverse event reports grouped by the country of the primary reporter. Dat...
+
+    Parameters
+    ----------
+    medicinalproduct : str
+        Drug name.
+    patientsex : str
+        Patient sex, leave it blank if you don't want to apply a filter.
+    patientagegroup : str
+        Patient age group.
+    serious : str
+        Whether the event was serious.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_reportercountry_by_drug_event",
+            "arguments": {
+                "medicinalproduct": medicinalproduct,
+                "patientsex": patientsex,
+                "patientagegroup": patientagegroup,
+                "serious": serious,
+            },
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_reportercountry_by_drug_event"]

tooluniverse/tools/FAERS_count_seriousness_by_drug_event.py

@@ -0,0 +1,63 @@
+"""
+FAERS_count_seriousness_by_drug_event
+
+Count the number of adverse event reports classified as serious or non-serious, filtered by drug ...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FAERS_count_seriousness_by_drug_event(
+    medicinalproduct: str,
+    patientsex: str,
+    patientagegroup: str,
+    occurcountry: str,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Count the number of adverse event reports classified as serious or non-serious, filtered by drug ...
+
+    Parameters
+    ----------
+    medicinalproduct : str
+        Drug name.
+    patientsex : str
+        Patient sex, leave it blank if you don't want to apply a filter.
+    patientagegroup : str
+        Patient age group.
+    occurcountry : str
+        Country where event occurred.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FAERS_count_seriousness_by_drug_event",
+            "arguments": {
+                "medicinalproduct": medicinalproduct,
+                "patientsex": patientsex,
+                "patientagegroup": patientagegroup,
+                "occurcountry": occurcountry,
+            },
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FAERS_count_seriousness_by_drug_event"]

tooluniverse/tools/FDA_get_abuse_dependence_info_by_drug_name.py

@@ -0,0 +1,55 @@
+"""
+FDA_get_abuse_dependence_info_by_drug_name
+
+Get information about drug abuse and dependence based on the drug name, specifically information ...
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FDA_get_abuse_dependence_info_by_drug_name(
+    drug_name: str,
+    limit: Optional[int] = None,
+    skip: Optional[int] = None,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Get information about drug abuse and dependence based on the drug name, specifically information ...
+
+    Parameters
+    ----------
+    drug_name : str
+        The name of the drug.
+    limit : int
+        The number of records to return.
+    skip : int
+        The number of records to skip.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FDA_get_abuse_dependence_info_by_drug_name",
+            "arguments": {"drug_name": drug_name, "limit": limit, "skip": skip},
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FDA_get_abuse_dependence_info_by_drug_name"]

tooluniverse/tools/FDA_get_abuse_info_by_drug_name.py

@@ -0,0 +1,55 @@
+"""
+FDA_get_abuse_info_by_drug_name
+
+Retrieve information about types of abuse based on the drug name.
+"""
+
+from typing import Any, Optional, Callable
+from ._shared_client import get_shared_client
+
+
+def FDA_get_abuse_info_by_drug_name(
+    drug_name: str,
+    limit: Optional[int] = None,
+    skip: Optional[int] = None,
+    *,
+    stream_callback: Optional[Callable[[str], None]] = None,
+    use_cache: bool = False,
+    validate: bool = True,
+) -> Any:
+    """
+    Retrieve information about types of abuse based on the drug name.
+
+    Parameters
+    ----------
+    drug_name : str
+        The name of the drug.
+    limit : int
+        The number of records to return.
+    skip : int
+        The number of records to skip.
+    stream_callback : Callable, optional
+        Callback for streaming output
+    use_cache : bool, default False
+        Enable caching
+    validate : bool, default True
+        Validate parameters
+
+    Returns
+    -------
+    Any
+    """
+    # Handle mutable defaults to avoid B006 linting error
+
+    return get_shared_client().run_one_function(
+        {
+            "name": "FDA_get_abuse_info_by_drug_name",
+            "arguments": {"drug_name": drug_name, "limit": limit, "skip": skip},
+        },
+        stream_callback=stream_callback,
+        use_cache=use_cache,
+        validate=validate,
+    )
+
+
+__all__ = ["FDA_get_abuse_info_by_drug_name"]