VariableIndex(3pm)

📦 version 2.1.1, in arch rolling

💅 VariableIndex(3pm)

okay so real quick — this page lives in LogReport's Lire Documentation, and it's all about Lire::Config::VariableIndex, aka the index of all the available variables in a TableInfo. bestie, it's the little lookup table that lets you pick a variable by name instead of doom-scrolling the whole table. iconic behavior honestly 🎀

✨ SYNOPSIS ✨

like, you use it from your lrcsml like this:

<lrcsml:reference name="name" index="categorical_variables" />
<lrcsml:reference name="name" index="numerical_variables" />
<lrcsml:reference name="name" index="variables" />

🌸 DESCRIPTION 🌸

so this object literally makes it possible to select a variable that's defined in a TableInfo — and that TableInfo is usually one that got created from a Lire::ReportSpec, or one that came straight out of a Lire::Report object. either way, she's a vibe. 💜

🦋 new( $table_info, [ $type ] )

creates a shiny new VariableIndex that wraps the $table_info Lire::Report::TableInfo object 🫶

the $type parameter can be 'both', 'categorical', or 'numerical' — depends on what kind of variables you're trying to select, y'know? and it defaults to 'both'. slay.

🧚 table_info()

returns the Lire::Report::TableInfo object that's wrapped by this Index. she's giving "just handing your table back to you" 💅

⭐ type()

returns the type attribute. that's it. that's the whole function. lowkey obsessed 😭

🔥 SEE ALSO 🔥

go read these, iykyk 👑

👑 AUTHOR 👑

Francis J. Lacoste <flacoste@logreport.org>

🌈 VERSION 🌈

$Id: VariableIndex.pm,v 1.3 2006/07/23 13:16:31 vanbaal Exp $

Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html.

fr fr read the license, it's not optional, that's the whole point 🫶

🎀 and that's the page! this version is from Lire 2.1.1, dated 2025-09-28 — catch you on the next manpage, bestie 💅✨

📦 where this page comes from