Learn Automating Report Generation | Visualization and Automation in Architectural Workflows

Automating the generation of textual reports is a powerful way to communicate project status and analysis results in architectural workflows. By creating reports programmatically, you can ensure consistency, save time, and quickly share up-to-date information with stakeholders. Automated reports can summarize key metrics, highlight important findings, and present data in a clear format, making them invaluable for both internal documentation and client presentations.


              1234567891011121314151617181920212223242526272829303132
            
import pandas as pd

def generate_room_report(df, size_threshold=30):
    """
    Generates a formatted string report summarizing room data.
    
    Args:
        df (pd.DataFrame): DataFrame with columns 'Room Name' and 'Area'.
        size_threshold (float): Area threshold for highlighting large rooms.
    
    Returns:
        str: Formatted report.
    """
    total_area = df['Area'].sum()
    average_area = df['Area'].mean()
    large_rooms = df[df['Area'] > size_threshold]

    report_lines = []
    report_lines.append(f"Architectural Room Report")
    report_lines.append("-" * 30)
    report_lines.append(f"Total number of rooms: {len(df)}")
    report_lines.append(f"Total area: {total_area:.2f} m²")
    report_lines.append(f"Average room area: {average_area:.2f} m²")
    report_lines.append("")
    report_lines.append(f"Rooms exceeding {size_threshold} m²:")
    if not large_rooms.empty:
        for _, row in large_rooms.iterrows():
            report_lines.append(f" - {row['Room Name']}: {row['Area']:.2f} m²")
    else:
        report_lines.append(" None")
    return "\n".join(report_lines)

The function above uses several string formatting techniques to create a readable report. The f-string syntax (e.g., f"Total area: {total_area:.2f} m²") allows you to embed variables directly within strings and control the number of decimal places displayed. This approach ensures that numerical results are both precise and easy to interpret. The function constructs the report as a list of lines, which are then joined with newline characters for a clean, multi-line output. By iterating over the filtered DataFrame of large rooms, the report dynamically lists all rooms that meet the specified size criterion, making the output adaptable to different datasets and thresholds.


              123456789
            
# Sample usage
data = {
    'Room Name': ['Living Room', 'Kitchen', 'Bedroom 1', 'Bedroom 2', 'Bathroom', 'Garage'],
    'Area': [35.5, 18.2, 22.0, 21.5, 8.0, 40.0]
}
df = pd.DataFrame(data)

report = generate_room_report(df, size_threshold=25)
print(report)

1. What are the key elements of an effective architectural report?

2. How can Python string formatting improve the clarity of automated reports?

Everything was clear?

Thanks for your feedback!

Section 3. Chapter 6

Ask AI

Ask anything or try one of the suggested questions to begin our chat

Suggested prompts:

Can you explain how the size_threshold parameter affects the report?

What happens if there are no rooms exceeding the threshold?

Can you show how to modify the report to include additional room attributes?

Swipe to show menu


              1234567891011121314151617181920212223242526272829303132
            
import pandas as pd

def generate_room_report(df, size_threshold=30):
    """
    Generates a formatted string report summarizing room data.
    
    Args:
        df (pd.DataFrame): DataFrame with columns 'Room Name' and 'Area'.
        size_threshold (float): Area threshold for highlighting large rooms.
    
    Returns:
        str: Formatted report.
    """
    total_area = df['Area'].sum()
    average_area = df['Area'].mean()
    large_rooms = df[df['Area'] > size_threshold]

    report_lines = []
    report_lines.append(f"Architectural Room Report")
    report_lines.append("-" * 30)
    report_lines.append(f"Total number of rooms: {len(df)}")
    report_lines.append(f"Total area: {total_area:.2f} m²")
    report_lines.append(f"Average room area: {average_area:.2f} m²")
    report_lines.append("")
    report_lines.append(f"Rooms exceeding {size_threshold} m²:")
    if not large_rooms.empty:
        for _, row in large_rooms.iterrows():
            report_lines.append(f" - {row['Room Name']}: {row['Area']:.2f} m²")
    else:
        report_lines.append(" None")
    return "\n".join(report_lines)


              123456789
            
# Sample usage
data = {
    'Room Name': ['Living Room', 'Kitchen', 'Bedroom 1', 'Bedroom 2', 'Bathroom', 'Garage'],
    'Area': [35.5, 18.2, 22.0, 21.5, 8.0, 40.0]
}
df = pd.DataFrame(data)

report = generate_room_report(df, size_threshold=25)
print(report)