evidence-dev / evidence Goto Github PK

Hi,

Thanks for sharing Evidence. Looks like it has great potential. I stumbled into an issue trying it today that I’d like to share with you.

I wanted to see the number of users in a database by date added:

As you can probably tell, the chart is hard to read. In addition, I miss features like being able to see data points on hover, zoom the X-axis and so on. (The chart seems a bit off when I compare it to the example data, but it’s hard to troubleshoot without any interactivity.)

Some thoughts on solutions

You are probably aware of these issues, and I can imagine that it must be a huge task to make charts work well. Personally, I would just grab Highcharts or something similar. Perhaps an easy fix would be to document how to use libraries like HIghcharts and Chart.js or similar with Evidence?

• Issue template
• Guide to running the mono repo locally
• PR guide

Example from Financial Times:

I’m curious about whether you are planning to add automatic testing capabilities to Evidence. That seems like one of the biggest wins of using code and source control.

For example, if I could do something like load an example database and check that my queries return the expected results, that would make me much more confident in my queries.

By default, the chart should treat nulls as zero to match up with the behaviour of the other components in the library

Example from The Economist:

Requests have come up for:

• Vega
• Plot.js
• Highcharts

We should migrate the docs site to an evidence project when feasible.

Requested in the product hunt discussion.

Need to investigate this.

Text anchor is set to middle, which causes overlapping labels when the units prop is a long string. Change text anchor to "start" to position the start of the string directly on the tick mark.

Only the first axis label is formatted correctly - the others all appear as the raw numbers.

• If x axis is numerical, sort by x ascending
• If x axis is categorical, sort by y descending

2 new format tags:

1. num (format as number with comma thousands separator, min 0 decimals, max 2)
2. num2 (same as above, but fix at 2 decimal places)

Example from Wall Street Journal:

xAxisTitle prop not exposed as an option

I think change them to be click to expand.

Thanks Levi!

Remove prop from BarChart component until we build a viable axis title for reverse axis charts

To connect the data warehouse the docs say to "update evidence.config.json" file, but in my most recent pull that fill is missing and I had to add manually (which solves the "can't connect to warehouse" issue I was having"

The zero line is technically a gridline, but it should stay visible when gridlines are turned off

Caused by the dataset that is outputted from the histogram component dropping the original column names. Change this output dataset to use the original x column name, which will pull through the format tag of the column.

1. Publication-quality formatting by default
2. Smart spacing between columns
3. Formatting options for each column (text alignment, value formats, text formats)
4. Smart text-wrapping rules for headers and table cell content
5. Handling of many columns (scrolling, visual indications of full table width)

Change currency formatting to user locale-based in formatValue and formatAxisLabels.

Automatically select currency symbol in formatTitle

Add an option to show multiple series in bar and column charts as groups rather than stacked, which is currently the only option.

Example from The Economist:

This looks like a great project - what's your plan, if any, to connect with arbitrary PostgreSQL databases?

Quick fix - change "value" to "frequency"

Setting the stacked chart extents does not work with dates because the grouping function treats instances of the same date as separate groups. Can use Date.parse() to get date into numerical format, which should allow the grouping function's equality checking to work.

Installer is causing challenges for a number of users. Proposing we move to a standalone starter repo for the near term.

With the project moving quickly, folks who have tried out an earlier version may have a cached version of the initializer on their machine, and they will run into issues.

There seems to be an issue with handling dates returned from BQ.
Problem query
SELECT EXTRACT(DATE FROM <timestampe> ) as Date, <some_metric> FROM <some_table>
returns a nested json object like

and can't be rendered in a chart since I have to reference values as

working query
When I extract only month as:
SELECT EXTRACT(MONTH FROM <timestampe> ) as Date, <some_metric> FROM <some_table>
The json object is not nested and the chart renders fine

Today, when you initialize an evidence project you get a full sveltekit project built in your directory.

This is pretty gnarly for our users, and it makes managing dependencies tricky for us.

Future state

1. A working project should only require a pages directory with .md files, and the required evidence.config and database.config files.
2. The only dependency should be @evidence-dev/evidence. All of the other deps should be upstream of that.
3. The __layout, svelte config, app.css, api route etc. files that are currently dropped in the directory should no longer be required.
4. If a user did want to modify app.css or __layout (e.g. a new "theme") they should be able to add them directly to their directory and modify from there, with the build system preferring their additions.

Proper spacing on either side of the chart for dates, weeks, months, quarters, and years. Currently set through padded extents calculation in Chart component.

It would be great to use OAuth to authenticate to BQ. You could expand the user base that way without having to rely on someones ability to create a service account

Details

Depending on the organization in Google Cloud Console, service accounts may need higher access than BigQuery User (which is the role currently specified in the docs)

Apply same checkInputs logic as in other components

Styles don't land instantly in development mode. Appears to be related to sveltejs/kit#915

1. Conditional font formatting (e.g., green font for increase, red for decrease)
2. Conditional cell formatting (background color)

Color palette for multi-series charts is not in app.css of the template project

Ability to set up hyperlinks for a column in your query result. For example, if you have parameterized pages for your customers and one column in your query result is your customer ID, you should be able to put that query result in a DataTable and have the customer ID column become a hyperlink to the page for each customer.

As in #5 it would be nice to have connectors for other dbs. Or maybe just a generic CustomConnector that can be any of available db connectors on npm.

Values are rendered in the line, but axis doesn't adjust to fit the values

• Support format tags in the same way as chart components
• Add format override

Adjust position of bars and columns to clearly show the axis line

When no data is present, bar height and column width functions will return NaN, which produces errors in the console. Add logic to return 0 instead.