Reports

SherlockML reports allow you to share the results of your work without having to copy files, make slides or download any information to your machine.

All your reports are version controlled. Their entire history is able to view at the click of a button. You can go back through the history of a report and see what changed at each date.

../_images/report_version_control.png

Create a report from a jupyter notebook

From any Jupyter notebook hit the publish button in the top right corner of the notebook, or right-click the notebook in the file browser. The markdown and output cells of your notebook, including static and interactive plots, will be rendered in HTML as a shared report.

Create a report from R Markdown

If you would like to write a report in R Markdown, you can do so using the SherlockML report R Markdown template. Simply select File > New File > R Markdown.. > From Template > SherlockML Report:

../_images/sherlockml-report-rmarkdown.png

Alternatively, if you already have a document written, simply set the following in your YAML front matter:

output: rsherlockml::report

Whenever you’re ready, hit the “Knit” button at the top of the editor window. RStudio will convert the document and publish it to the “Reports” section. If you knit a document again that has already been published, a new version of the report will automatically be generated for you.

SherlockML R Markdown reports support the same output options as the R Markdown HTML template, such as toc: true for tables of content.

Exporting notebooks to PDF

You can export a notebook to PDF from the notebook’s web interface:

  1. Create a Jupyter server.

  2. On the server’s terminal, enter the following commands:

    $ sudo apt-get install texlive-full pandoc
    

    The command takes about ten minutes to complete.

  3. Once the command completes, go to the notebook you want to export on the workspace and click RUN/EDIT NOTEBOOK.

  4. Click File > Download as > PDF via LaTeX. This will download your notebook as a PDF to your local filesystem.

../_images/export_notebook_to_pdf.png