Skip to content
This repository has been archived by the owner on Jun 8, 2020. It is now read-only.

Documentation needed: How are Reports different from Visualizations? #67

Open
ghost opened this issue Apr 4, 2015 · 1 comment
Open

Comments

@ghost
Copy link

ghost commented Apr 4, 2015

I've just started playing with reportr---I love the concept and I'm interested in helping to extend it.

Can someone explain the concepts of a Report? They're not documented in the README, and I can read the source code, but the intent isn't clear.

It looks like a Report wraps a Visualization and adds an id and title. It looks Reports are one-to-one with Visualizations.

Is that right? If so, why separate the two objects?

@andheiberg
Copy link

Reports are a group of visualizations. It could be imagined you had a "Health" and a "Goals" report.

"Health" has visualizations for monitoring your physical and mental health.

"Goals" has visualizations for monitoring how you are reaching your goals.

They are two different concerns they should be different objects.

Reports have a title and many visualizations. Visualizations have many attributes and one report.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant