From 7be9f0067e63f7a889e10c096b1f3fd36cbedf81 Mon Sep 17 00:00:00 2001
From: Matthias <xmatthias@outlook.com>
Date: Tue, 11 Feb 2020 20:45:53 +0100
Subject: [PATCH] Update data-analysis documentation to properly initialize
 configuration

---
 docs/strategy_analysis_example.md             | 27 +++++++++----------
 .../templates/strategy_analysis_example.ipynb | 27 +++++++++----------
 2 files changed, 26 insertions(+), 28 deletions(-)

diff --git a/docs/strategy_analysis_example.md b/docs/strategy_analysis_example.md
index cc6b9805f..2d77edaed 100644
--- a/docs/strategy_analysis_example.md
+++ b/docs/strategy_analysis_example.md
@@ -7,18 +7,19 @@ Debugging a strategy can be time-consuming. FreqTrade offers helper functions to
 
 ```python
 from pathlib import Path
+from freqtrade.configuration import Configuration
+
 # Customize these according to your needs.
 
+# Initialize empty configuration object
+config = Configuration.from_files([])
+# Optionally, Use existing configuration file
+# config = Configuration.from_files(["config.json"])
+
 # Define some constants
-timeframe = "5m"
+config["ticker_interval"] = "5m"
 # Name of the strategy class
-strategy_name = 'SampleStrategy'
-# Path to user data
-user_data_dir = Path('user_data')
-# Location of the strategy
-strategy_location = user_data_dir / 'strategies'
-# Location of the data
-data_location = Path(user_data_dir, 'data', 'binance')
+config["strategy"] = "SampleStrategy"
 # Pair to analyze - Only use one pair here
 pair = "BTC_USDT"
 ```
@@ -28,8 +29,8 @@ pair = "BTC_USDT"
 # Load data using values set above
 from freqtrade.data.history import load_pair_history
 
-candles = load_pair_history(datadir=data_location,
-                            timeframe=timeframe,
+candles = load_pair_history(datadir=config["data_dir"],
+                            timeframe=config["ticker_interval"],
                             pair=pair)
 
 # Confirm success
@@ -44,9 +45,7 @@ candles.head()
 ```python
 # Load strategy using values set above
 from freqtrade.resolvers import StrategyResolver
-strategy = StrategyResolver.load_strategy({'strategy': strategy_name,
-                                          'user_data_dir': user_data_dir,
-                                          'strategy_path': strategy_location})
+strategy = StrategyResolver.load_strategy(config)
 
 # Generate buy/sell signals using strategy
 df = strategy.analyze_ticker(candles, {'pair': pair})
@@ -86,7 +85,7 @@ Analyze a trades dataframe (also used below for plotting)
 from freqtrade.data.btanalysis import load_backtest_data
 
 # Load backtest results
-trades = load_backtest_data(user_data_dir / "backtest_results/backtest-result.json")
+trades = load_backtest_data(config["user_data_dir"] / "backtest_results/backtest-result.json")
 
 # Show value-counts per pair
 trades.groupby("pair")["sell_reason"].value_counts()
diff --git a/freqtrade/templates/strategy_analysis_example.ipynb b/freqtrade/templates/strategy_analysis_example.ipynb
index eea8fb85f..06fc3f557 100644
--- a/freqtrade/templates/strategy_analysis_example.ipynb
+++ b/freqtrade/templates/strategy_analysis_example.ipynb
@@ -23,18 +23,19 @@
    "outputs": [],
    "source": [
     "from pathlib import Path\n",
+    "from freqtrade.configuration import Configuration\n",
+    "\n",
     "# Customize these according to your needs.\n",
     "\n",
+    "# Initialize empty configuration object\n",
+    "config = Configuration.from_files([])\n",
+    "# Optionally, Use existing configuration file\n",
+    "# config = Configuration.from_files([\"config.json\"])\n",
+    "\n",
     "# Define some constants\n",
-    "timeframe = \"5m\"\n",
+    "config[\"ticker_interval\"] = \"5m\"\n",
     "# Name of the strategy class\n",
-    "strategy_name = 'SampleStrategy'\n",
-    "# Path to user data\n",
-    "user_data_dir = Path('user_data')\n",
-    "# Location of the strategy\n",
-    "strategy_location = user_data_dir / 'strategies'\n",
-    "# Location of the data\n",
-    "data_location = Path(user_data_dir, 'data', 'binance')\n",
+    "config[\"strategy\"] = \"SampleStrategy\"\n",
     "# Pair to analyze - Only use one pair here\n",
     "pair = \"BTC_USDT\""
    ]
@@ -48,8 +49,8 @@
     "# Load data using values set above\n",
     "from freqtrade.data.history import load_pair_history\n",
     "\n",
-    "candles = load_pair_history(datadir=data_location,\n",
-    "                            timeframe=timeframe,\n",
+    "candles = load_pair_history(datadir=config[\"data_dir\"],\n",
+    "                            timeframe=config[\"ticker_interval\"],\n",
     "                            pair=pair)\n",
     "\n",
     "# Confirm success\n",
@@ -73,9 +74,7 @@
    "source": [
     "# Load strategy using values set above\n",
     "from freqtrade.resolvers import StrategyResolver\n",
-    "strategy = StrategyResolver.load_strategy({'strategy': strategy_name,\n",
-    "                                          'user_data_dir': user_data_dir,\n",
-    "                                          'strategy_path': strategy_location})\n",
+    "strategy = StrategyResolver.load_strategy(config)\n",
     "\n",
     "# Generate buy/sell signals using strategy\n",
     "df = strategy.analyze_ticker(candles, {'pair': pair})\n",
@@ -137,7 +136,7 @@
     "from freqtrade.data.btanalysis import load_backtest_data\n",
     "\n",
     "# Load backtest results\n",
-    "trades = load_backtest_data(user_data_dir / \"backtest_results/backtest-result.json\")\n",
+    "trades = load_backtest_data(config[\"user_data_dir\"] / \"backtest_results/backtest-result.json\")\n",
     "\n",
     "# Show value-counts per pair\n",
     "trades.groupby(\"pair\")[\"sell_reason\"].value_counts()"