Rename functions

plateo/applications/doe.py

@@ -4,18 +4,18 @@
 from ..parsers.picklist_from_tables import columnnames
 
 
-def volumetable_from_valuetable(valuetable, source_plate):
+def convert_valuetable_to_volumetable(valuetable, source_plate):
     # 1 microliter = 1e-6 L
     pass
 
 
-def valuetable_from_csv(filename):
+def import_valuetable_from_csv(filename):
     valuetable = pandas.read_csv(filename, index_col=0)
 
     return valuetable
 
 
-def dataframe_from_volume_table(volumetable, source_plate, dest_plate):
+def convert_volumetable_to_actiontable(volumetable, source_plate, dest_plate):
     """Convert a volume-based transfer table into an action-based format."""
 
     factor_wells_dict = {}
@@ -58,12 +58,12 @@ def dataframe_from_volume_table(volumetable, source_plate, dest_plate):
             ]
             transfer_list += [transfer]
 
-    dataframe = pandas.DataFrame(columns=columnnames, data=transfer_list)
+    actiontable = pandas.DataFrame(columns=columnnames, data=transfer_list)
 
-    return dataframe
+    return actiontable
 
 
-def volumetable_from_csv_file(filename, unit=1e-6):
+def import_volumetable_from_csv_file(filename, unit=1e-6):
     # 1 microliter = 1e-6 L
     volumetable = pandas.read_csv(filename, index_col=0)
     volumetable = volumetable * unit

tests/test_doe.py

@@ -3,8 +3,8 @@
 import pandas
 
 from plateo.applications.doe import (
-    dataframe_from_volume_table,
-    volumetable_from_csv_file,
+    convert_volumetable_to_actiontable,
+    import_volumetable_from_csv_file,
 )
 from plateo.parsers import plate_from_content_spreadsheet
 from plateo.containers import Plate96
@@ -14,14 +14,14 @@
 
 
 def test_volumetable_from_csv_file():
-    assert type(volumetable_from_csv_file(volumetable_path)) == pandas.DataFrame
+    assert type(import_volumetable_from_csv_file(volumetable_path)) == pandas.DataFrame
 
 
 def test_dataframe_from_volume_table():
-    volumetable = volumetable_from_csv_file(volumetable_path)
+    volumetable = import_volumetable_from_csv_file(volumetable_path)
     source_plate = plate_from_content_spreadsheet(source_plate_path)
     dest_plate = Plate96(name="dest")
-    dataframe = dataframe_from_volume_table(
+    dataframe = convert_volumetable_to_actiontable(
         volumetable=volumetable, source_plate=source_plate, dest_plate=dest_plate
     )