Skip to content

UsingDataframes

RoiArthurB edited this page Jul 28, 2026 · 1 revision

Using Dataframes

Introduction

GAMA 2026-06 introduces the dataframe type: a tabular data structure with named columns, similar to a dataframe in R or pandas. It is designed for loading, transforming, and saving tabular data — CSV or Excel files, SQL query results, or data built directly in GAML — without having to juggle lists of lists.

A dataframe is a value like any other: it can be stored in an attribute, passed to actions, and displayed with write.

Creating a dataframe

The dataframe_with operator builds a dataframe from a list of column names and a list of rows:

dataframe df <- dataframe_with(["name", "age"], [["Alice", 30], ["Bob", 25]]);
write pretty_print(df);

You can also cast a compatible value (e.g. a matrix or a map of columns) with the dataframe casting operator:

dataframe df2 <- dataframe(my_matrix);

Loading and saving files

The dataframe_file constructor reads a dataframe from a file; the format is deduced from the extension (csv, tsv, json, xlsx, parquet, avro):

dataframe cities <- dataframe(dataframe_file("../includes/cities.csv"));

Use is_dataframe(a_file) to test whether a file can be read as a dataframe.

Inspecting a dataframe

  • pretty_print(df) returns a readable, aligned string representation of the dataframe (an extended form takes maximum row/column/width limits: pretty_print(df, max_rows, max_cols, max_width)).
  • cell(df, row_index, "column") returns the value at the given row index and column name.
  • df row_at i and df column_at j return a single row or column as a list.
  • rows_list(df) and columns_list(df) return all rows (or columns) as a list of lists.

Transforming a dataframe

All transformation operators return a new dataframe and leave the original untouched.

  • df select_columns ["name", "age"] keeps only the given columns.
  • filter(df, "column", value) keeps only the rows where the column equals the value.
  • df iloc [0, 2, 4] keeps only the rows at the given indices (df iloc 0 returns a single row as a list).
  • add_column(df, "new_col", default_value) adds a column filled with a default value.
  • df remove_empty "column" removes the rows with an empty value in the column.
  • df1 + df2 concatenates two dataframes.
  • join(df1, df2, "key") inner-joins two dataframes on a common key column. Variants accept a list of key columns and an explicit join type: join(df1, df2, ["key1", "key2"], "left") — one of "inner" (default), "left", "right" or "full".
  • pivot(df, "index_col", "pivot_col", "value_col") pivots the dataframe: the index column becomes row labels, the pivot column values become new column names, and the value column provides the cell values.
dataframe adults <- filter(people, "status", "adult") select_columns ["name", "age"];

Dataframes and databases

Dataframes integrate directly with SQL databases via JDBC:

  • load_sql(jdbc_url, user, password, query) runs a SQL query and returns the result as a dataframe.
  • load_table(jdbc_url, user, password, table_name) loads a whole table into a dataframe.
  • save_table(df, jdbc_url, user, password, table_name) saves a dataframe to an existing table with a compatible schema.

Pass empty strings for user/password if the database does not require credentials.

dataframe results <- load_sql("jdbc:sqlite:../includes/Student.db", "", "", "SELECT * FROM registration");

The insert action of the database skill also accepts a dataframe to insert several rows in a single batch — see Using Database.

Full list of operators

See the Dataframe-related operators section of the operators reference.

  1. What's new (Changelog)
  2. Migration Guide (2025-06 → 2026-06)
  1. Installation and Launching
    1. Installation
    2. Launching GAMA
    3. Updating GAMA
    4. Installing Plugins
  2. Workspace, Projects and Models
    1. Navigating in the Workspace
    2. Changing Workspace
    3. Importing Models
  3. Editing Models
    1. GAML Editor (Generalities)
    2. GAML Editor Tools
    3. Validation of Models
  4. Running Experiments
    1. Launching Experiments
    2. Experiments User interface
    3. Controls of experiments
    4. Parameters view
    5. Inspectors and monitors
    6. Displays
    7. Batch Specific UI
    8. Errors View
  5. Running Headless
    1. Getting Started
    2. Headless Legacy
    3. Headless Batch
  6. Preferences
  7. Troubleshooting
  1. Introduction
    1. Start with GAML
    2. Organization of a Model
    3. Basic programming concepts in GAML
  2. Manipulate basic Species
  3. Global Species
    1. Regular Species
    2. Defining Actions and Behaviors
    3. Interaction between Agents
    4. Attaching Skills
    5. Inheritance
  4. Defining Advanced Species
    1. Grid Species
    2. Graph Species
    3. Mirror Species
    4. Multi-Level Architecture
  5. Defining GUI Experiment
    1. Defining Parameters
    2. Defining Displays Generalities
    3. Defining 3D Displays
    4. Defining Charts
    5. Defining Monitors and Inspectors
    6. Defining Export files
    7. Defining User Interaction
  6. Classes and Objects
    1. Class Definition and Instantiation
    2. Attributes and Actions
    3. Inheritance
    4. Virtual Classes
    5. Advanced Features
  7. Exploring Models
    1. Run Several Simulations
    2. Batch Experiments
    3. Exploration Methods
  8. Optimizing Models
    1. Runtime Concepts
    2. Analyzing code performance
    3. Optimizing Models
  9. Multi-Paradigm Modeling
    1. Control Architecture
    2. Defining Differential Equations
  1. Manipulate OSM Data
  2. Cleaning OSM Data
  3. Diffusion
  4. Using Database
  5. Using Dataframes
  6. Using FIPA ACL
  7. Using BDI with BEN
  8. Using Driving Skill
  9. Manipulate dates
  10. Manipulate lights
  11. Using comodel
  12. Save and restore Simulations
  13. Using network
  14. Writing Unit Tests
  15. Ensure model's reproducibility
  16. Going further with extensions
    1. Calling R
    2. Using Graphical Editor
    3. Using Git from GAMA
  1. Built-in Species
  2. Built-in Skills
  3. Built-in Architecture
  4. Statements
  5. Data Type
  6. File Type
  7. Stats Extension
  8. Sound Extension
  9. BDI Extension
  10. FIPA Skill
  11. Expressions
    1. Literals
    2. Units and Constants
    3. Pseudo Variables
    4. Variables And Attributes
    5. Operators (Definition)
    6. Operators [A-A]
    7. Operators [B-C]
    8. Operators [D-H]
    9. Operators [I-M]
    10. Operators [N-R]
    11. Operators [S-Z]
  12. Exhaustive list of GAMA Keywords
  1. Installing the development version
    1. Install GAMA source code with Eclipse plugin
  2. Developing Extensions
    1. Developing Plugins
    2. Developing Skills
    3. Developing Statements
    4. Developing Operators
    5. Developing Types
    6. Developing Species
    7. Developing Control Architectures
    8. Index of annotations
  3. Introduction to GAMA Java API
    1. Architecture of GAMA
    2. IScope
  4. Using GAMA flags
  5. Creating a release of GAMA
  6. Documentation generation

  1. Predator Prey
  2. Road Traffic
  3. Incremental Model
  4. Luneray's flu
  5. BDI Agents
  6. Forager RL
  7. SIR Analysis
  8. 3D Model

  1. Team
  2. Projects using GAMA
  3. Scientific References
  4. Training Sessions

Resources

  1. Videos
  2. Conferences
  3. Pedagogical materials

Clone this wiki locally