Merge pull request #81 from brain-image-library/80-document-method-get_random_sample-using-chatgpt

80 document method get random sample using chatgpt

Author: icaoberg

braininventory/get.py

@@ -262,8 +262,28 @@ def __get_award_numbers(df):
 
 
 def __get_affiliations(df):
-    return df["affiliation"].value_counts().to_dict()
+    """
+    Return a dictionary containing the count of occurrences of each unique value
+    in the "affiliation" column of the input DataFrame.
+
+    Parameters:
+    -----------
+    df : pandas DataFrame
+        The input DataFrame containing a column named "affiliation" from which
+        the unique values will be counted.
 
+    Returns:
+    --------
+    dict
+        A dictionary where the keys represent unique values in the "affiliation"
+        column, and the values represent the count of occurrences of each unique value.
+
+    Note:
+    -----
+    The input DataFrame `df` should have a column named "affiliation" containing
+    categorical data, where the function will count the occurrences of each unique value.
+    """
+    return df["affiliation"].value_counts().to_dict()
 
 def __get_contributors(df):
     return df["contributorname"].value_counts().to_dict()