Parse Dataframe Component

The Parse Dataframe component transforms structured dataframes into formatted text output using customizable templates. It handles complex data structures, maintains relationships, and provides flexible formatting options.

Parse Dataframe workflow and architecture

Configuration Parameters

Required Parameters

template: Text template configuration
- format: Output format (markdown, text, html)
- structure: Template structure definition
- placeholders: Variable mappings
- formatting: Style rules
dataframe: Input dataframe to parse

Optional Parameters

separator: Custom text separator
- line: Line break type
- section: Section delimiter
- column: Column separator
- custom: Custom separator function

Output Format

{
  "text": string,
  "metadata": {
    "format": string,
    "length": number,
    "sections": number,
    "processing_time": number
  },
  "statistics": {
    "rows_processed": number,
    "columns_used": number,
    "template_variables": number,
    "formatting_rules_applied": number
  },
  "template_info": {
    "name": string,
    "version": string,
    "placeholders_matched": number,
    "formatting_success": boolean
  },
  "errors": [
    {
      "type": string,
      "message": string,
      "location": {
        "row": number,
        "column": string,
        "context": string
      }
    }
  ]
}

Features

Template-based formatting
Multiple output formats
Custom separators
Variable mapping
Style customization
Error handling
Performance metrics
Metadata preservation

Note: Ensure template placeholders match dataframe columns. Handle missing or null values appropriately.

Tip: Use conditional formatting for dynamic content. Implement proper error handling for missing data.

Example Usage

const parser = new DataframeParser({
  template: {
    format: "markdown",
    structure: `
      # {title}
      
      ## Summary
      {summary_text}
      
      ## Details
      {#each rows}
      - **{name}**: {value} ({unit})
      {/each}
      
      ## Analysis
      {analysis_text}
    `,
    placeholders: {
      title: "report_title",
      summary_text: "summary_column",
      rows: {
        name: "metric_name",
        value: "metric_value",
        unit: "metric_unit"
      },
      analysis_text: "analysis_column"
    },
    formatting: {
      headers: "bold",
      values: "plain",
      units: "italic"
    }
  },
  separator: {
    line: "\n",
    section: "\n\n",
    column: " | "
  }
});

const result = await parser.parse({
  dataframe: inputDataframe,
  options: {
    skipMissing: true,
    preserveFormatting: true,
    maxLength: 5000
  }
});

Common Templates:

// Markdown Report
{
  "format": "markdown",
  "structure": "# {title}\n\n{content}"
}

// HTML Table
{
  "format": "html",
  "structure": "<table>{rows}</table>"
}

// Plain Text List
{
  "format": "text",
  "structure": "{#each items}- {name}: {value}\n"
}