Mop: Mop up a data pack file for inclusion a package

View source: R/Mop.R

MopR Documentation

Mop up a data pack file for inclusion a package

Description

Mop up a data pack file for inclusion a package

Usage

Mop(
  DT,
  value.name = getOption("Census2016.value.name", "persons"),
  suborder = NULL,
  dry.run = FALSE,
  totals = NULL,
  use.varI = TRUE,
  verbose = FALSE,
  assign_into = getOption("Census.Mop.assign.env")
)

Arguments

DT

A data.table that separated into the right variables.

value.name

The value column in DT.

suborder

If column names are not meant to be ordered alphabetically, this specifies a suborder for columns.

dry.run

(logical, default: FALSE) If TRUE, the data.tables are not assigned; the function is run to see if the code will run.

totals

A data.table which specifies the total for each region key.

use.varI

(logical) If TRUE, the default, DT must contain a column varI, the metadata entries, and these varI will be excluded from subsequent calls to fread[GTW].

verbose

Be chatty and report progress (for debugging)?

assign_into

The environment into which the result is to be assigned. Typically set to the global environment.

Value

Called for its side-effect: assignment.


HughParsonage/Census2016.spec documentation built on July 16, 2022, 11:40 p.m.