From 04afcf3b367d2998f81c8fbc6629e3c26e357b16 Mon Sep 17 00:00:00 2001
From: Johannes Pfeifer <jpfeifer@gmx.de>
Date: Tue, 7 Jun 2022 16:19:32 +0200
Subject: [PATCH] dseries: expand documentation on loading Excel files
(cherry picked from commit 4fc644c3225b628bf2f59d3a5110ea30c16a7b25)
---
doc/manual/source/time-series.rst | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/doc/manual/source/time-series.rst b/doc/manual/source/time-series.rst
index 2e1a8539b3..79c61907fd 100644
--- a/doc/manual/source/time-series.rst
+++ b/doc/manual/source/time-series.rst
@@ -1025,8 +1025,9 @@ The dseries class
``.xls/.xlsx`` (Octave only supports ``.xlsx`` files and the
`io <https://octave.sourceforge.io/io/>`__ package from
Octave-Forge must be installed). The extension of the file
- should be explicitly provided. A typical ``.m`` file will have
- the following form::
+ should be explicitly provided.
+
+ A typical ``.m`` file will have the following form::
FREQ__ = 4;
INIT__ = '1994Q3';
@@ -1051,6 +1052,12 @@ The dseries class
typically usefull if ``INIT__`` is not provided in the data
file.
+ If an ``.xlsx`` file is used, the first row should be a header
+ containing the variable names. The first column may contain date
+ information that must correspond to a valid date format recognized
+ by Dynare. If such date information is specified in the first column,
+ its header name must be left empty.
+
.. construct:: dseries (DATA_MATRIX[,INITIAL_DATE[,LIST_OF_NAMES[,TEX_NAMES]]])
dseries (DATA_MATRIX[,RANGE_OF_DATES[,LIST_OF_NAMES[,TEX_NAMES]]])
--
GitLab