API

Chunk Options

Code chunks are blocks that look like

```{kernel_name, [chunk_name], **kwargs}
# code
```

The kernel_name is required, and chunk_name is optional. All parameters are separated by a comma.

kernel_name(name: str)

Name of the kernel to use for executing the code chunk. Required. See jupyter kernelspec list.

chunk_name(chunk_name: str)

Name for the chunk. Controls the filename for supporting files created by that chunk. Optional.

echo(echo=True)

whether to include the input-code in the rendered output. Default True.

eval(eval=True)

Whether to execute the code cell. Default True.

results(s)

str; how to display the results

  • hide: hide the chunk output (but still execute the chunk)
width(w)

Width for output figure. See http://pandoc.org/MANUAL.html#images

Warning

This will probably change to fig.width in a future release.

height(w)

Height for output figure. See http://pandoc.org/MANUAL.html#images

Warning

This will probably change to fig.height in a future release.