Skip to content

SampleEvent

Bases: MermaidBase

The SampleEvent class is responsible for fetching summary information about sample events across various projects.

Source code in seasnake/summaries/sample_event.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class SampleEvent(MermaidBase):
    """
    The SampleEvent class is responsible for fetching summary information about sample events
    across various projects.
    """

    def summary(self, limit_columns: bool = True, flatten: bool = True) -> DataFrame:
        """
        Get a summary of sample events data from MERMAID.

        This method retrieves summary information about Sample Events and returns the result as
        a pandas DataFrame. By default, it limits the columns included in the DataFrame and
        flattens the `protocols` (or sample methods) column. However, these behaviors can be
        changed using the input parameters.

        Args:
            limit_columns (bool, optional): Whether to limit the columns included
                in the DataFrame. Defaults to True.
            flatten (bool, optional): Whether to flatten the 'protocols' column in
                the DataFrame. Defaults to True.

        Returns:
            DataFrame

        Examples:
        ```
        from seasnake import SampleEvent

        sample_event = SampleEvent()
        print(sample_event.summary())
        ```
        """
        columns = [
            "project",
            "tags",
            "country",
            "site",
            "latitude",
            "longitude",
            "reef_type",
            "reef_zone",
            "reef_exposure",
            "management",
            "sample_date",
            "data_policy_beltfish",
            "data_policy_benthiclit",
            "data_policy_benthicpit",
            "data_policy_benthicpqt",
            "data_policy_habitatcomplexity",
            "data_policy_bleachingqc",
            "project_notes",
            "site_notes",
            "management_notes",
            "contact_link",
            "protocols",
        ]
        column_rename_map = {
            "project_name": "project",
            "country_name": "country",
            "site_name": "site",
            "management_name": "management",
        }

        url = "/summarysampleevents/"
        df = self.data_frame_from_url(
            url,
            columns=columns if limit_columns else None,
            rename_columns=column_rename_map if limit_columns else None,
        )
        return self.flatten(df, "protocols") if flatten else df

summary(limit_columns=True, flatten=True)

Get a summary of sample events data from MERMAID.

This method retrieves summary information about Sample Events and returns the result as a pandas DataFrame. By default, it limits the columns included in the DataFrame and flattens the protocols (or sample methods) column. However, these behaviors can be changed using the input parameters.

Parameters:

Name Type Description Default
limit_columns bool

Whether to limit the columns included in the DataFrame. Defaults to True.

 True
flatten bool

Whether to flatten the 'protocols' column in the DataFrame. Defaults to True.

 True

Returns:

Type Description
DataFrame

DataFrame

Examples:

from seasnake import SampleEvent

sample_event = SampleEvent()
print(sample_event.summary())
Source code in seasnake/summaries/sample_event.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def summary(self, limit_columns: bool = True, flatten: bool = True) -> DataFrame:
    """
    Get a summary of sample events data from MERMAID.

    This method retrieves summary information about Sample Events and returns the result as
    a pandas DataFrame. By default, it limits the columns included in the DataFrame and
    flattens the `protocols` (or sample methods) column. However, these behaviors can be
    changed using the input parameters.

    Args:
        limit_columns (bool, optional): Whether to limit the columns included
            in the DataFrame. Defaults to True.
        flatten (bool, optional): Whether to flatten the 'protocols' column in
            the DataFrame. Defaults to True.

    Returns:
        DataFrame

    Examples:
    ```
    from seasnake import SampleEvent

    sample_event = SampleEvent()
    print(sample_event.summary())
    ```
    """
    columns = [
        "project",
        "tags",
        "country",
        "site",
        "latitude",
        "longitude",
        "reef_type",
        "reef_zone",
        "reef_exposure",
        "management",
        "sample_date",
        "data_policy_beltfish",
        "data_policy_benthiclit",
        "data_policy_benthicpit",
        "data_policy_benthicpqt",
        "data_policy_habitatcomplexity",
        "data_policy_bleachingqc",
        "project_notes",
        "site_notes",
        "management_notes",
        "contact_link",
        "protocols",
    ]
    column_rename_map = {
        "project_name": "project",
        "country_name": "country",
        "site_name": "site",
        "management_name": "management",
    }

    url = "/summarysampleevents/"
    df = self.data_frame_from_url(
        url,
        columns=columns if limit_columns else None,
        rename_columns=column_rename_map if limit_columns else None,
    )
    return self.flatten(df, "protocols") if flatten else df