From da83283afc1894574d7b7ebf7e3aef218b91925a Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Tue, 29 May 2018 12:37:05 +1000
Subject: [PATCH] Minor rewrite to functino conv. samples to posterior

- Renames the functin to show it is the `posterior` attribute which is
  generated
---
 tupak/result.py  | 8 +++++---
 tupak/sampler.py | 3 ++-
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/tupak/result.py b/tupak/result.py
index 321e352f5..e5f9f1f7b 100644
--- a/tupak/result.py
+++ b/tupak/result.py
@@ -189,9 +189,10 @@ class Result(dict):
         """
         logging.warning("plot_distributions deprecated")
 
-    def samples_to_data_frame(self, likelihood=None, priors=None, conversion_function=None):
+    def samples_to_posterior(self, likelihood=None, priors=None,
+                             conversion_function=None):
         """
-        Convert array of samples to data frame.
+        Convert array of samples to posterior (a Pandas data frame).
 
         Parameters
         ----------
@@ -203,7 +204,8 @@ class Result(dict):
             Function which adds in extra parameters to the data frame,
             should take the data_frame, likelihood and prior as arguments.
         """
-        data_frame = pd.DataFrame(self.samples, columns=self.search_parameter_keys)
+        data_frame = pd.DataFrame(
+            self.samples, columns=self.search_parameter_keys)
         if conversion_function is not None:
             conversion_function(data_frame, likelihood, priors)
         self.posterior = data_frame
diff --git a/tupak/sampler.py b/tupak/sampler.py
index a81f01b80..43c5e153f 100644
--- a/tupak/sampler.py
+++ b/tupak/sampler.py
@@ -524,7 +524,8 @@ def run_sampler(likelihood, priors=None, label='label', outdir='outdir',
                 conversion_function(result.injection_parameters)
         result.fixed_parameter_keys = sampler.fixed_parameter_keys
         # result.prior = prior  # Removed as this breaks the saving of the data
-        result.samples_to_data_frame(likelihood=likelihood, priors=priors, conversion_function=conversion_function)
+        result.samples_to_posterior(likelihood=likelihood, priors=priors,
+                                    conversion_function=conversion_function)
         result.kwargs = sampler.kwargs
         result.save_to_file()
         if plot:
-- 
GitLab