jimbrig
commented
1 week ago App
Core Root Level App:
app_ui.Rapp_server.Rapp_run.R
App-Related:
app_assets.Rapp_config.Rapp_logging.R
UI Inputs
Core Filtering Inputs:
- Portfolio Selector
- Name:
input_portfolio - Function:
input_portfolio() - Type:
shinyWidgets::pickerInput()(i.e. Select, Dropdown, Multi-Select) - Choices: Lists portfolios from the
portfoliostable - Purpose: Filter properties based on their associated portfolio for portfolio-specific analysis.
- Property Selector
- Name:
input_property - Function:
input_property() - Type:
shinyWidgets::pickerInput()(i.e. Select, Dropdown, Multi-Select) - Choices: List of properties with IDs as names and names as values. Conditional to
input_portfolio. - Purpose: Narrow down the analysis and data to specific properties or a set of properties.
- Leasing Period
- Name:
input_leasing_period - Function:
input_leasing_period() - Type: Date Range Picker
- Choices:
- Purpose: Filter leases, financials, and occupancy data based on the move-in/move-out dates or financial periods.
- (Property) Floorplan Selector
- Name:
input_floorplan - Function:
input_floorplan() - Type: Select
- Options: List of available floor plans for selected properties
- Purpose: Analyze data for specific floorplans
From Auth:
input_emailinput_passwordinput_otp
Modules
mod_homeormod_dashboardmod_summarymod_reportsmod_portfoliosmod_propertiesmod_floorplansmod_leasing
Dashboard Module
- KPI Value Boxes: Total Number of Properties, Occupancy Rate, ?
- KPI Card
- Recent Alerts and Notifications
Properties Module
- Property List or Grid
- Map View of Properties (colored by Portfolio)
- Property Comparison Tool
Leasing Module
- Lease Status Summary
- Occupancy Trends
- Leasing Performance by Property
Reports Module
Top-Level Modules:
- [ ] Dashboard:
mod_dashboard() - [ ] Property Portfolio:
mod_properties() - [ ] Financial Reports:
mod_reports() - [ ] Data Management:
mod_data()
Nested Modules:
Data Retrieval and Storage Module
Fetches data from Entrata API and stores it in the database
Components:
- API Connection and Authentication Handler
- Database Connection Handler
- Data Synchronization Logic
Property Module
Display and manage individual property details
Components:
- Property Summary Card
- Leasing Details
- Leasing Performance Chart
- Projected Occupancy
- Occupancy Chart
- Property Metadata and Map
- Property Floor Plans, Floorplan Details, Rate Details
- Projected Rent Growth
- Property Installment Amenity Charges and Specials/Discounts
Leasing Performance Chart:
Leasing Module
Handles leasing data and operations
Components:
- Lease Status Overview
- Upcoming Renewals
- Vacancy Predictions
Financial Module
Generates and displays financial reports
Components:
- Revenue/Expense Breakdown
- Cash Flow Analysis
- Accounting
Data Visualization Module
Creates reusable charts, tables, and graphics
Components:
- Line Chart
- Bar Chart
- Pie Chart
Goal: Migrate and refactor all
shinydashboard,shinydashboardPlus, andbs4Dashpackage implementations from the gmhLeasingDashboard package tobslib.bslibviapage_navbar(): replacedashboardPage()withpage_navbar().nav_panel()andnav_menu()withinbslib::page_navbar()to create the top navigation structure.nav_panel()should call the correspondingmod_*_ui()UI module function.mod_header_ui()module that includes the GMH logo, dropdowns, and necessary buttons/links. Apply this in thetitleargument forpage_navbar()mod_footer_ui()modulelayout_columns(),layout_column_wrap(), etc.card's to wrap distinct sections of content within each page/tab.