Merge branch 'main' into 20-new-metric-request-meta-version-10

Author: icaoberg

braininventory/__init__.py

@@ -1 +1 @@
-from .get import *
+from .get import *

braininventory/get.py

@@ -3,6 +3,7 @@
 import json
 from datetime import date
 
+
 def today():
     """
 	Get today's snapshot of Brain Image Library.
@@ -23,84 +24,85 @@ def today():
     else:
         print("Error: Failed to fetch JSON data")
         return pd.DataFrame()
-    
+
+
 def __get_number_of_datasets(df):
-     return len(df)
+    return len(df)
+
 
 def __get_completeness_score(df):
-      return df['score'].sum()/len(df)
+    return df["score"].sum() / len(df)
+
 
 def __is_reachable(url):
-	response = requests.get(url)
+    response = requests.get(url)
+
+    if response.status_code == 200:
+        return True
+    else:
+        return False
 
-	if response.status_code == 200:
-		return True
-	else:
-		return False
 
 def __get_metadata_version(df):
-    return df['metadata_version'] .value_counts().to_dict()
+    return df["metadata_version"].value_counts().to_dict()
+
 
 def __get_contributor(df):
-    return df['contributor'].value_counts().to_dict()
+    return df["contributor"].value_counts().to_dict()
+
 
 def __get_affilation(df):
-    return df['affiliation'].value_counts().to_dict()
+    return df["affiliation"].value_counts().to_dict()
+
 
 def __get_award_number(df):
-    return df['award_number'].value_counts().to_dict()
+    return df["award_number"].value_counts().to_dict()
+
 
 def __get_species(df):
-    return df['species'].value_counts().to_dict()
+    return df["species"].value_counts().to_dict()
+
 
 def __get_cnbtaxonomy(df):
-    return df['cnbtaxonomy'].value_counts().to_dict()
+    return df["cnbtaxonomy"].value_counts().to_dict()
+
 
 def __get_samplelocalid(df):
-    return df['samplelocalid'].value_counts().to_dict()
+    return df["samplelocalid"].value_counts().to_dict()
+
 
 def __get_genotype(df):
-    return df['genotype'].value_counts().to_dict()
+    return df["genotype"].value_counts().to_dict()
+
 
 def __get_generalmodality(df):
-    return df['generalmodality'].value_counts().to_dict()
+    return df["generalmodality"].value_counts().to_dict()
+
 
 def __get_technique(df):
-    return df['technique'].value_counts().to_dict()
+    return df["technique"].value_counts().to_dict()
+
 
 def __get_locations(df):
-    return df['locations'].value_counts().to_dict()
+    return df["locations"].value_counts().to_dict()
+
+
+def __get_contributors(df):
+    """
+    This returns an array of contributor names from the contributorname column.
+    """
+    return df["contributorname"].unique()
+
+
+def __get_project_names(df):
+	'''
+	Gets the unique list of project names.
+
+    Input: dataframe
+    Output: list 
+    '''
+	return df['project'].unique()
 
-def report():
-    # Get today's date
-	tdate = date.today()
-
-	# Convert date to string
-	tdate = tdate.strftime("%Y-%m-%d")
-        
-	df = today()
-
-	report = {}
-	report['date'] = tdate
-	report['number_of_datasets'] = __get_number_of_datasets(df)
-	report['completeness_score'] = __get_completeness_score(df)
-	report['metadata_version'] = __get_metadata_version(df)
-    report['contributor'] =  __get_contributor(df)
-    report['affiliation'] =  __get_affilation(df)
-    report['award_number'] = __get_award_number(df)
-    report['species'] = __get_species(df)
-    report['cnbtaxonomy'] = __get_cnbtaxonomy(df)
-    report['samplelocalid'] = __get_samplelocalid(df)
-    report['genotype'] = __get_genotype(df)
-    report['generalmodality'] = __get_generalmodality(df)
-    report['technique'] = __get_technique(df)
-    report['locations'] = __get_locations(df)
-     
-	report['is_reachable'] = df['URL'].apply(__is_reachable)
-
-	return report
-
-#  
 def __get_list_of_projects(df):
     '''
     Get the list of names for unique projects
@@ -111,7 +113,6 @@ def __get_list_of_projects(df):
 
     return df['project'].unique().to_dict()
 
-# 
 def __get_number_of_projects(df):
     '''
     Get the number of unique projects
@@ -122,7 +123,37 @@ def __get_number_of_projects(df):
 
     return len(df['project'].unique())
 
+def __get__percentage_of_metadata_version_1(df):
+  '''
+  Add documentation here.
+  '''
+  return len(df[df['metadata_version'] == 1])/len(df)
 
-def __get__metadata_version_1(df):
-  return len(df[df['metadata_version'] == 1]) / len(df)
-
+def report():
+    # Get today's date
+    tdate = date.today()
+
+    # Convert date to string
+    tdate = tdate.strftime("%Y-%m-%d")
+
+    df = today()
+
+    report = {}
+    report["date"] = tdate
+    report["number_of_datasets"] = __get_number_of_datasets(df)
+    report["completeness_score"] = __get_completeness_score(df)
+    report["metadata_version"] = __get_metadata_version(df)
+    report["contributor"] = __get_contributor(df)
+    report["affiliation"] = __get_affilation(df)
+    report["award_number"] = __get_award_number(df)
+    report["species"] = __get_species(df)
+    report["cnbtaxonomy"] = __get_cnbtaxonomy(df)
+    report["samplelocalid"] = __get_samplelocalid(df)
+    report["genotype"] = __get_genotype(df)
+    report["generalmodality"] = __get_generalmodality(df)
+    report["technique"] = __get_technique(df)
+    report["locations"] = __get_locations(df)
+    report["percentage_of_version_1"] = __get__percentage_of_metadata_version_1(df)
+    report["is_reachable"] = df["URL"].apply(__is_reachable)
+
+    return report