Adds a new Statistics Page

akshat22 commented 8 months ago

Description

Adds a new statistics page #871 to Field Book with the following features:

Displays multiple stats divided into season cards.
Ability to toggle between year and month view.
Display additional context on individual stats via dialogs and toast messages.
Ability to export individual cards as an image with a Field Book logo by long-pressing the card.
Display a calendar style heatmap for the number of observations collected on each day.

Type of change

What type of changes does your code introduce? Put an x in boxes that apply.

[ ] CHANGE (fix or feature that would cause existing functionality to not work as expected)
[x] FEATURE (non-breaking change which adds functionality)
[ ] BUGFIX (non-breaking change which fixes an issue)
[ ] ENHANCEMENT (non-breaking change which improves existing functionality)
[ ] NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Checklist:

[ ] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[ ] I have updated relevant documentation

Changelog entry

Please add a one-line changelog entry below. This will be copied to the changelog file during the release process.

Added a new statistics page to display summary of collected data.

chaneylc commented 8 months ago

First of all this looks awesome!

[x] Replace snackbar message with a share button on each card, alternatively it could be a toolbar button and allow the cards to be selectable.
[x] I noticed the statistics_card.xml is fairly complicated, I think you can use grid layout manager / recycler view / adapter pattern here where you define view holders for each stat type, so it's easier to add/adjust stats in the future.
[x] image count is only based on "photo", this will only count images captured on the device camera, there are other photo formats like go pro and usb that won't be counted. For now update your logic with the offbeat Formats enum.
[x] declare a threshold variable (30) for your total interval check
[x] static strings should be replaced with resources
[x] Since the stat processing time scales with the amount of data in the database, the activity should start with some sort of "loading stats..." UI while the data processes in the background. I found with large databases it takes a while for the screen to appear after clicking Statistics.
[ ] ~~@trife do you want this feature wrapped in alpha/beta settings?~~

trife commented 8 months ago

@akshat22 for the heatmap, you're going to need to either use the heatmap composable or adapt one of the vertical scrolling calendar views.

trife commented 8 months ago

[x] Replace the export icon with this one
[x] Cancel previous toast before showing new ones
[x] Toast text changes: Entries: "...entries have been phenotyped"; Data: "...observations have been collected"; Time: "...hours spent phenotyping"; Photos: "...photos have been captured"
[x] Dialog title changes: "Fields imported in YYYY", use unique ID for title of Most dialog
[x] Month view needs a loading dialog while it processes
[x] Use month names instead of numbers (e.g. 2024 February)
[x] Heatmap: Add toolbar buttons to move calendar to the first day with obs, last day with obs, and select a date range
[x] Add the counter icon to the heatmap toolbar: when clicked it swaps the day number in the calendar for the number of observations collected that day
[x] Add date range picker that filters calendar view to specified dates
[ ] Mostly out of curiosity to see how it looks: set the titles of the stat elements to hidden
[ ] Make sure you use one of the available Field Book text styles for the textviews in this PR
[x] How difficult is it to stylize the exported card? It might be good to change the top line of the images to " Field Book Stats for February 2024"
[x] Use a tablayout for the stats with "Total", "By Year", and "By Month" tabs. Since this will remove the need to swap back and forth between month/year views, remove the current swap icon and reuse it for the heatmap feature instead of the checkerboard.
[x] Swap the icons for fields and plots. Update the icon in ConfigActivity for Fields to match.

chaneylc commented 7 months ago

The Config Activity Fields icon is different, is that on purpose?

Tried to select a date range, I think it crashes if you only have one date:

FATAL EXCEPTION: main (Ask Gemini)
                                                                                                    Process: com.fieldbook.tracker.debug, PID: 26100
                                                                                                    java.lang.NullPointerException: Attempt to invoke virtual method 'int java.util.Calendar.get(int)' on a null object reference
                                                                                                        at com.fieldbook.tracker.dialogs.DateRangePickerDialog.lambda$onCreateDialog$0$com-fieldbook-tracker-dialogs-DateRangePickerDialog(DateRangePickerDialog.java:60)
                                                                                                        at com.fieldbook.tracker.dialogs.DateRangePickerDialog$$ExternalSyntheticLambda0.onClick(Unknown Source:2)
                                                                                                        at androidx.appcompat.app.AlertController$ButtonHandler.handleMessage(AlertController.java:167)
                                                                                                        at android.os.Handler.dispatchMessage(Handler.java:107)
                                                                                                        at android.os.Looper.loopOnce(Looper.java:232)
                                                                                                        at android.os.Looper.loop(Looper.java:317)
                                                                                                        at android.app.ActivityThread.main(ActivityThread.java:8501)
                                                                                                        at java.lang.reflect.Method.invoke(Native Method)
                                                                                                        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:552)
                                                                                                        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:878)

akshat22 commented 7 months ago

The Config Activity Fields icon is different, is that on purpose?

@chaneylc This is in reference to one of Trevor's notes in the previous comment to switch the icons for Fields and Plots.

Tried to select a date range, I think it crashes if you only have one date:

Noted, will fix this.

trife commented 4 months ago

I've changed the target to fields_modifications which is going to be our base v6 version where this will be released. I have a few minor requests for updates to close this out and get it merged:

[x] Swap back to the old fields icon in both the Statistics and ConfigActivity
[x] Use this for the entries icon in Statistics
[x] Heatmap currently doesn't work- I'm just seeing static purple for each of the dates

trife commented 1 week ago

@chaneylc it looks your implementation crashes if the images don't exist on the device. I'll send you a database to test with to recreate the issue.

PhenoApps / Field-Book