How to make objects available notebook previews of child documents?

[ns-rse]

Description

Hi,

I'm trying to create a manuscript and as its fairly long I'd like to split it into a number of child documents under the sections/ directory.

I've found though that when I try to do this (see example repository at ns-rse/quarto-test) that objects created in the higher level index.qmd or other child documents (in this example the earthquake list/vector which I moved into its own child documents sections/introduction.qmd) is not available to the code in sections/analysis.qmd.

The initial processing to index.knit.md works fine but there is a failure on attempting to Rendering notebook previews as the earthquake object can not be found.

processing file: index.qmd
1/9                  
2/9 [unnamed-chunk-1]
3/9                  
4/9 [fig-timeline]   
5/9                  
6/9 [unnamed-chunk-3]
7/9                  
8/9 [unnamed-chunk-4]
9/9                  
output file: index.knit.md

pandoc 
  to: html
  output-file: /home/neil/work/git/hub/ns-rse/quarto-test/index.html
  standalone: true
  section-divs: true
  html-math-method: mathjax
  wrap: none
  default-image-extension: png
  toc: true
  number-sections: true
  
metadata
  
  document-css: false
  link-citations: true
  date-format: long
  lang: en
  manuscript:
    article: index.qmd
    notebooks:
      - notebook: sections/analysis.qmd
      - notebook: sections/introduction.qmd
      - notebook: notebooks/explore-earthquakes.qmd
    mecaFile: index-meca.zip
  notebook-preview-options:
    back: true
  theme: cosmo
  title-block-style: manuscript
  lightbox: auto
  comments:
    hypothesis: true
  title: La Palma Earthquakes
  author:
    - name: Steve Purves
      orcid: 0000-0002-0760-5497
      corresponding: true
      email: [email protected]
      roles:
        - Investigation
        - Project administration
        - Software
        - Visualization
      affiliations:
        - Curvenote
    - name: Rowan Cockett
      orcid: 0000-0002-7859-8394
      corresponding: false
      roles: []
      affiliations:
        - Curvenote
  keywords:
    - La Palma
    - Earthquakes
  abstract: |
    In September 2021, a significant jump in seismic activity on the island of La Palma (Canary Islands, Spain) signaled the start of a volcanic crisis that still continues at the time of writing. Earthquake data is continually collected and published by the Instituto Geográphico Nacional (IGN). ...
  plain-language-summary: |
    Earthquake data for the island of La Palma from the September 2021 eruption is found ...
  key-points:
    - A web scraping script was developed to pull data from the Instituto Geogràphico Nacional into a machine-readable form for analysis
    - Earthquake events on La Palma are consistent with the presence of both mantle and crustal reservoirs.
  date: last-modified
  bibliography:
    - references.bib
  citation:
    container-title: Earth and Space Science
  google-scholar: true
  toc-location: left
  clear-hidden-classes: none
  remove-hidden: all
  unroll-markdown-cells: true
  
Rendering notebook previews
[1/1] analysis.qmd


processing file: analysis.qmd
1/2 [unnamed-chunk-1]
Error:
! object 'eruptions' not found
Backtrace:
 1. base::mean(eruptions)



Quitting from lines 2-4 [unnamed-chunk-1] (analysis.qmd)
Execution halted
ERROR: Rendering of output notebook produced an unexpected result

Process quarto-preview-/home/neil/work/git/hub/ns-rse/quarto-test/index.qmd exited abnormally with code 1

I've tried adding the following to both the _quarto.yaml and the YAML header of index.qmd to disable generating notebook previews.

[ns-rse]

I solved this thanks to help from a user on the Data Science Learning Slack.

The solution was to force exclusion of my subsections from being recognised as individual notebooks by prefixing them with _ (underscore) and so...

{{< include sections/_analysis.qmd >}}

was included verbatim and no attempt is made to convert it to its own Notebook on preview/rendering.