Statis...P::List(3pm)

💖 Statistics::R::REXP::List — the Perl manual page, but make it cute 💖

okay bestie, this is the manual page for Statistics::R::REXP::List from the User Contributed Perl Documentation, and we're gonna get through it together. grab a snack. 🍓

---

✨ NAME ✨

Statistics::R::REXP::List — it's an R generic vector (a list), fr fr 🦋

---

🌸 VERSION 🌸

version 1.0002 — that's the one, periodt.

---

🎀 SYNOPSIS 🎀

here's the vibe, copy-paste ready:

use Statistics::R::REXP::List

my $vec = Statistics::R::REXP::List->new([
    1, '', 'foo', ['x', 22]
]);
print $vec->elements;

---

👑 DESCRIPTION 👑

so like, an object of this class represents an R list — which is also called a generic vector, aka VECSXP, iykyk. and here's the iconic part: list elements can themselves be lists, so you can build a whole tree structure out of these. nesting is the moment. 🌈

---

💅 METHODS 💅

Statistics::R::REXP:List inherits from Statistics::R::REXP::Vector, and it adds no extra restrictions on what its elements can be. freedom, honestly.

missing values (NA in R) have the value undef. no cap. 😭

⭐ sexptype

the SEXPTYPE of generic vectors is VECSXP. that's it, that's the whole thing.

💜 to_pl

the Perl value of the list is an array reference pointing at the Perl values of its elements — but (and this is the spicy bit) it uses a plain scalar value to represent elements that are atomic vectors of length 1, instead of a one-element array reference. ✨

the idea here? in R, 1:3 and list(1, 2, 3) can often be used interchangeably, even though the list is really made of three integer vectors, each of length one. and now both of them get the same native Perl representation:

[1, 2, 3]

so pretty. so convenient. 🫶

heads up though: this only applies to elements that are atomic vectors. an element of type list will always be represented as an array reference:

"list(list(1), list(2), list(3))->to_pl" -> "[ [ 1 ], [ 2 ], [ 3 ] ]"

---

😭 BUGS AND LIMITATIONS 😭

classes in the REXP hierarchy are intended to be immutable. please, bestie, do not try to change their value or attributes. just let them be their main character selves. 🙈

there are no known bugs in this module. for bug reporting, go see Statistics::R::IO. 💀

---

🌸 SUPPORT 🌸

see Statistics::R::IO for support and contact information. that's where the help lives.

---

💖 AUTHOR 💖

Davor Cubranic <cubranic@stat.ubc.ca> — icon, legend, the moment. 👑

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is Copyright (c) 2017 by University of British Columbia.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007

slay. 💅

---

and that's a wrap on perl v5.34.0, dated 2022-02-10 — thanks for reading bestie, you ate this whole manual page, no crumbs. 🎀💖✨