From 16b824735c42d1ab63baec81248c73a7837fdbcd Mon Sep 17 00:00:00 2001
From: richfitz <rich.fitzjohn@gmail.com>
Date: Thu, 7 Mar 2024 13:22:51 +0000
Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20mrc-ide/?=
 =?UTF-8?q?mcstate2@aba27e2f79702d554b5d7a20ad4a04823159bdf4=20?=
 =?UTF-8?q?=F0=9F=9A=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 pkgdown.yml                   |  2 +-
 reference/mcstate_sample.html | 16 ++++++++++++++--
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/pkgdown.yml b/pkgdown.yml
index 391d9a99..a5974187 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.11
 pkgdown: 2.0.7
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-03-05T16:12Z
+last_built: 2024-03-07T13:22Z
 
diff --git a/reference/mcstate_sample.html b/reference/mcstate_sample.html
index cbbdda76..d5052c9e 100644
--- a/reference/mcstate_sample.html
+++ b/reference/mcstate_sample.html
@@ -119,8 +119,20 @@ <h2>Arguments</h2>
     <h2>Value</h2>
     
 
-<p>A list of parameters and densities.</p>
-    </div>
+<p>A list of parameters and densities; we'll write tools for
+dealing with this later.  Elements include:</p><ul><li><p><code>pars</code>: A matrix with as many columns as you have parameters, and
+as many rows as the total number of samples taken across all
+chains (<code>n_steps * n_chains</code>)</p></li>
+<li><p><code>density</code>: A vector of model log densities, one per step (length
+<code>n_steps * n_chains</code>)</p></li>
+<li><p><code>initial</code>: A record of the initial conditions, a matrix with as
+many columns as you have parameters and <code>n_chains</code> rows</p></li>
+<li><p><code>details</code>: Additional details reported by the sampler; this will
+be a list of length <code>n_chains</code> (or <code>NULL</code>) and the details
+depend on the sampler.  This one is subject to change.</p></li>
+<li><p><code>chain</code>: An integer vector indicating the chain that the samples
+came from (1, 2, ..., <code>n_chains</code>)</p></li>
+</ul></div>
 
   </div>
   <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">