bcgov / bcgov/lcfs

LCFS - Credit Market Snapshot Alignment with Metabase Credit Market Report

Open
#4,902 0 comments 0 reactions 1 assignee Claimed by @prv-proton View on GitHub
Credit Transfers & Transactions DEMO THIS Medium Metabase - Power BI Task
Dominant language
Python
Stars
6
Forks
6
Avg merge
2d 4h
Merged PRs (30d)
87

Description

**Describe the Task**

Reorganize the LCFS Portal Credit Market Report to provide a clearer and more balanced presentation of market information. The revised design should group related content under cohesive section headings and avoid visually emphasizing Category A1 over the other transfer categories.

Use the reorganized Metabase report as the functional prototype. Refer to the approved wireframes for LCFS Portal-specific layout, styling and user experience adjustments.

Retain all existing report cards, charts, tables and data unless otherwise specified.

[Credit Market Snapshot Alignment with Metabase Credit Market Report](https://www.figma.com/proto/MZNxIKFBC0qZSUvgF6s8B5/4902-LCFS---Credit-Market-Snapshot-Alignment-with-Metabase-Credit-Market-Report?node-id=1-808&t=HT7eU2ddMTk3btpG-1&scaling=min-zoom&content-scaling=fixed&page-id=0%3A1)

**Purpose**

Improve the report’s information hierarchy, usability and accessibility by:

- Presenting the report as an overall credit market report rather than an A1-focused report
- Grouping related market information into clear sections
- Making transfer classification descriptions easier to access without occupying excessive page space
- Improving the usability of wide data tables
- Giving users flexible options to download the report and underlying data

**Proposed Report Organization**

Organize the report into the following sections:

1. Report description
2. Current Market Snapshot
3. Transfer Classifications
4. Year-to-Date Market Activity
5. Market Trends and Historical Performance
6. Cumulative Market Statistics
7. Detailed Market Reports

The Average Credit Price for All Transfers and Average Credit Price for A1 Transfers should be presented with equal visual weight.

**Functional Requirements**

- Retain the existing report description section at the top of the page.
- Retain all existing report cards, charts, tables and supporting information.
- Group the report content using the reorganized Metabase version as the prototype.
- Follow the approved wireframes for LCFS Portal-specific adjustments, including layout, spacing, headings, styling and responsive behaviour.
- Present Category A1 alongside Categories A, B and C without giving A1 greater visual prominence.
- Place the transfer classification descriptions in an accordion.
- Allow users to expand and collapse the transfer classification accordion.
- Clearly label each transfer category within the accordion.
- Lock or freeze the Month column in the Monthly Market Report table so it remains visible while a user scrolls horizontally.
- Add an option to download the entire Credit Market Report as a polished, presentation-ready PDF.
- Ensure the PDF reflects the report’s organization, section headings and visible data in a readable format.
- Add separate download buttons for the:
- Monthly Market Report
- Quarterly Market Report
- Annual Market Report
- Allow each detailed report to be downloaded in both CSV and Excel formats.
- Use clear file names that identify the report type and download date or reporting period, where applicable.
- Ensure download controls are clearly associated with the relevant report or data table.

**Acceptance Criteria**

- [ ] The report description remains at the top of the page.
- [ ] All existing report cards, charts, tables and data are retained.
- [ ] Report content is grouped under the approved section headings.
- [ ] The reorganized Metabase report is used as the functional prototype.
- [ ] The approved wireframes are followed for LCFS Portal-specific design and user experience requirements.
- [ ] Category A1 is not given greater visual prominence than Categories A, B and C.
- [ ] The Average Credit Price cards for All Transfers and A1 Transfers have equal visual weight.
- [ ] Transfer classification descriptions are contained within an accordion.
- [ ] The transfer classification accordion can be expanded and collapsed using a mouse and keyboard.
- [ ] The accordion has an appropriate default state based on the approved wireframes.
- [ ] The Month column in the Monthly Market Report remains visible while horizontally scrolling through the table.
- [ ] Users can download the entire report as a polished and readable PDF.
- [ ] The PDF includes the report title, description, section headings, reporting period, charts, summary metrics and detailed tables.
- [ ] Users can download the monthly data in CSV and Excel formats.
- [ ] Users can download the quarterly data in CSV and Excel formats.
- [ ] Users can download the annual data in CSV and Excel formats.
- [ ] Downloaded data matches the data displayed in the applicable table, including active filters or reporting periods.
- [ ] Download buttons have clear and accessible labels.
- [ ] The reorganized report works at supported desktop and mobile screen sizes.
- [ ] Existing report calculations and values are not changed by the reorganization.
- [ ] Existing permissions and data-access controls continue to apply to on-screen and downloaded content.

**Additional Context**

The Metabase version should guide the content grouping and overall report flow but should not be treated as the final visual design. The LCFS Portal implementation should follow the wireframes for the final interface, including Portal-specific components, accessibility requirements and responsive behaviour.

The report should maintain a clear hierarchy that answers the following questions in order:

1. What is happening in the market now?
2. How is the market performing year to date?
3. What are the longer-term price and volume trends?
4. What detailed monthly, quarterly and annual data are available?

- The Credit Market Report has undergone significant updates and the public Credit Market Snapshot must be brought into alignment.
- Review all charts, labels, category definitions, metrics, and data presentation against the latest Metabase report.
- Ensure visual presentation remains clear and accessible.
- Validate keyboard navigation, responsive behaviour, and WCAG 2.2 accessibility compliance.
- Test across supported browsers and devices.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.