party_df: A 'party_df' partitioned data frame

Description Usage Arguments Value Examples

View source: R/partydf.R

Description

This S3 class represents a data frame partitioned across workers in a cluster. You can use this constructor if you have already spread data frames spread across a cluster. If not, start with [partition()] instead.

Usage

1
party_df(cluster, name, auto_rm = FALSE)

Arguments

cluster

A cluster

name

Name of data frame variable. Must exist on every worker, be a data frame, and have the same names.

auto_rm

If 'TRUE', will automatically 'rm()' the data frame on the workers when this object is created.

Value

An S3 object with class 'multidplyr_party_df'.

Examples

1
2
3
4
5
6
7
8
9
# If a real example, you might spread file names across the clusters
# and read in using data.table::fread()/vroom::vroom()/qs::qread().
cl <- default_cluster()
cluster_send(cl[1], n <- 10)
cluster_send(cl[2], n <- 15)
cluster_send(cl, df <- data.frame(x = runif(n)))

df <- party_df(cl, "df")
df

multidplyr documentation built on Feb. 9, 2021, 1:07 a.m.