Data

Tools

Indexes

Applications

Experiments

Open Source Science

PlutoReport

Make awesome reports and talk slides in Pluto!

https://github.com/dhruvasambrani/plutoreport.jl

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Make awesome reports and talk slides in Pluto!

Basic Info
  • Host: GitHub
  • Owner: DhruvaSambrani
  • License: gpl-3.0
  • Language: Julia
  • Default Branch: main
  • Size: 540 KB
Statistics
  • Stars: 32
  • Watchers: 1
  • Forks: 0
  • Open Issues: 8
  • Releases: 5
Created about 4 years ago · Last pushed over 3 years ago
Metadata Files
Readme License Citation

README.md

PlutoReport.jl

docs stable DOI

Make awesome reports and talk slides in Pluto!

Why

Pluto is already an awesome platform to make interactive notebooks in julia. Along with the markdown and latex support, one can harness the interactivity of PlutoUI to make anything that they wish to make. This has lead to a rise in Pluto being used as an educational tool. With PlutoReport, we envision pluto notebooks being used for scientific publishing too.

Whereas LaTeX has become the de facto standard for publishing, it is inherently a two step process, to first generate the data and plots, and then to insert these along with the content. Such a separation is naturally more time consuming for the writers. I believe that such a separation is not a necessity in the publishing worklow. Further, the seperation of data and content also shows up in the lack of codes being available for readers.

Another use of Pluto is in making presentations for talks. A common drawback of pdf slides in, say beamer, is the complexity of adding interactivity in the slides.

While Pluto already provides most of the things we need in terms of interactivity, and also the hidden present() feature, there are certain things like citations, arbitrary slide breaks, presentation controls etc which are missing. This package attempts to add these features without users having to write them out themselves.

The end goal is this: A single document, which is code, documentation, talk slides and a full fledged report which the reader can interact with on any device, with easy ways to export and publish static html, active notebooks, and pdfs, and with opt in features to display cited papers so the reader can quickly look at the reference without losing context, all while being easy to learn and write for the author of the paper, but nearly as powerful as LaTeX. Yeah, ambitious, but possible. CSS/JS, Julia, Pluto/UI with export features already make it halfway, this package does the rest.

Features

  1. A fancy title for your report - Title
  2. A floating control panel to set the amount of time of your talk, and toggle presentation mode - presentation_controls. Control slide movement with the mouse, scroll or PlutoUI.TableOfContents
  3. A nice clock to show you how much time you have left - presentation_ui
  4. Add inline citations with @cite. You can even style them according to your wish, following the norms of your referencing style via style_citations
  5. Generates a References list from a bibtex file and actually cited works automatically. See the docs for References.
  6. Multiple aesthetic fixes for the report to look professional. apply_css_fixes
  7. A cute little laser pointer in presentation mode

Experimental and Future Features

  • Display abstracts from the references on a single click
  • Share DOI of a refernce to Zotero, Mendeley etc. Maybe even Mastodon just for fun
  • Sections that are hidden in presentations
  • Speaker Notes ??
  • Making papers accessible to ScreenReaders and such.
  • Integration with DrWatson.jl

Installation

In any cell of your Pluto notebook,

julia using PlutoReport

And you are done!!

Examples of reports and talks

You can find example notebooks here with the associated bibtex files. Make sure you have the notebook and bibtex files in the same folder!

If you just want to see how it looks like, look at the hosted example page. This however will not have all the fancy features that makes this package useful.

I've also made a repo for more examples of PlutoReport - PlutoReport-Examples, website

Send a PR to feature your works in PlutoReports.jl!!

Owner

  • Name: Dhruva Sambrani
  • Login: DhruvaSambrani
  • Kind: user
  • Company: @IISERM

Studying BS Physics at IISER, Mohali

Citation (CITATION.cff) 

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Sambrani
    given-names: Dhruva
    orcid: https://orcid.org/0000-0001-6254-4757
title: DhruvaSambrani/PlutoReport.jl
version: v0.4.0-zenodo
date-released: 2022-11-29

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 48
  • Total Committers: 2
  • Avg Commits per committer: 24.0
  • Development Distribution Score (DDS): 0.125
Top Committers
Name Email Commits
Dhruva Sambrani 4****i@u****m 42
CompatHelper Julia c****y@j****g 6
Committer Domains (Top 20 + Academic)
julialang.org: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 13
  • Total pull requests: 7
  • Average time to close issues: about 13 hours
  • Average time to close pull requests: 4 minutes
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 2.15
  • Average comments per pull request: 0.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 6
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • DhruvaSambrani (8)
  • dmetivie (4)
  • JuliaTagBot (1)
Pull Request Authors
  • github-actions[bot] (6)
  • DhruvaSambrani (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • julia 9 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
juliahub.com: PlutoReport

Make awesome reports and talk slides in Pluto!

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 9 Total
Rankings
Dependent repos count: 9.9%
Stargazers count: 19.2%
Average: 30.4%
Dependent packages count: 38.9%
Forks count: 53.5%
Last synced: 8 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/documentation.yml actions
  • actions/checkout v2 composite
  • julia-actions/setup-julia latest composite