Nested Scales and Multi-Dimensional Indexes for Modeling

Documentation for package ‘nestedscales’ version 0.2.0

Help Pages

-- A --

as.data.frame.NestedScale	The leaftable of a NestedScale
as.data.frame.nestedscales::NestedScale	The leaftable of a NestedScale
as_scale_array	Data on scales as a dense array
as_scale_table	Data on scales as a dense array
attach_aliases_scale	Attach aliases to a scale
attach_attributes_scale	Attach physical attributes to a scale

-- B --

backend	Backends: the table types the verbs accept
backend_bind_rows	Backends: the table types the verbs accept
backend_distinct	Backends: the table types the verbs accept
backend_is_lazy	Backends: the table types the verbs accept
backend_lazy	Backends: the table types the verbs accept
backend_of	Backends: the table types the verbs accept
backend_pull	Backends: the table types the verbs accept
backend_restore	Backends: the table types the verbs accept
backend_scan	Backends: the table types the verbs accept
backend_schema	Backends: the table types the verbs accept

-- C --

clear_scale_dirs	Shipped scale definitions
clear_scale_distances	Register a distance
clear_scale_maps	Clear the registered crosswalks
clear_scale_rules	Clear the rule registry
cluster_contiguous	Cluster the units of a scale under a contiguity constraint
cluster_medoids	The representative unit of each cluster
cluster_scale	Cluster the units of a scale into a new frame
cluster_sweep	Cluster quality across a range of k
convert_scale	Convert unit-keyed quantities with a member attribute

-- F --

filter_product	Subset a product componentwise
filter_scale	Subset a NestedScale by unit

-- G --

get_scale_distance	Register a distance
get_scale_map	Register / look up a direct crosswalk
get_scale_map_between	Register / look up a direct crosswalk
get_scale_rule	Look up a registered rule

-- I --

is_valid_frame

Validate frame names

-- J --

join_product	Attach every axis's labels to product-indexed data
join_scale	Attach scale labels and memberships to a dataset

-- L --

list_scale_classes	Write and read a subclass's payload in a definition file
list_scale_dirs	Shipped scale definitions
list_scale_distances	Register a distance
list_scale_maps	Register / look up a direct crosswalk
list_scale_rules	List registered rules

-- N --

names.NestedScale

Frames of a NestedScale

-- O --

open_scale_dataset

Open a scale-aware dataset

-- P --

print.scale_dataset	Open a scale-aware dataset
print.summary_Scale	Summarize a NestedScale
print.summary_ScaleProduct	Summarize a product
product_atoms	Realise the atoms of a product
product_coverage	Coverage of each axis
product_frames	Frames of each axis
product_keys	The data key column of each axis
product_size	Size of a product
product_weights	Weight columns of each axis
prune_scale	Collapse a NestedScale to a coarser frame

-- R --

read_scale	Write a scale as a definition file, and read one back
recast	Recast data through a scale
recast_crosswalk	Recast values through a given crosswalk
recast_from_atoms	Recast unit data down to the atom layer, and back
recast_product	Recast data indexed by a product of scales
recast_scale	Recast values from one resolution to another
recast_to_atoms	Recast unit data down to the atom layer, and back
reconcile_scale	Check fine data against an independent parent total
register_scale_class	Write and read a subclass's payload in a definition file
register_scale_dir	Shipped scale definitions
register_scale_distance	Register a distance
register_scale_map	Register / look up a direct crosswalk
register_scale_map_between	Register / look up a direct crosswalk
register_scale_rule	Register how a parameter should be recast

-- S --

scale_aliases	Read the alias table
scale_alias_property	An alias property for a subclass
scale_ancestors	Navigate a NestedScale's hierarchy
scale_ancestry	Ancestry between all frame pairs
scale_atom_level	The level at which a scale enumerates its atoms
scale_atom_pairs	Atom-level correspondence between two frames
scale_attributes	Read attributes, resolved along the hierarchy
SCALE_ATTRIBUTE_KINDS	Kinds of attribute
scale_axes	Axes of a product
scale_catalog	Shipped scale definitions
scale_children	Navigate a NestedScale's hierarchy
scale_class	The scale classes, for subclassing and dispatch
scale_coverage	Coverage of a sampled NestedScale
scale_crosses	Do two frames form a product?
scale_dataset_info	Describe a stored dataset without opening it fully
scale_descendants	Navigate a NestedScale's hierarchy
scale_distance	Distance between the units of a scale
SCALE_DISTANCES	Built-in distances
scale_example	A small example NestedScale
scale_example2	A second small example NestedScale
scale_family	Immediate parent-child table between two frames
scale_frames	Frames of a NestedScale
scale_from_leaftable	Build a NestedScale from a flat table of atoms
scale_is	Is this a scale, or a product of scales?
scale_is_product	Is this a scale, or a product of scales?
scale_is_uniform	Are the units of a frame the same size?
scale_key	The atom key column name
scale_leaftable	The leaftable of a NestedScale
scale_map	Crosswalk between two frames of a scale
scale_map_between	Crosswalk between two scales through their shared atoms
scale_match	Match labels to members, strictly
scale_navigate	Navigate a NestedScale's hierarchy
scale_nests	Do two frames nest?
scale_parents	Navigate a NestedScale's hierarchy
scale_payload_collapse	Collapse a subclass's per-atom payload
scale_payload_io	Write and read a subclass's payload in a definition file
scale_payload_slice	Subset a subclass's per-atom payload
scale_product	Combine scales into a product index
scale_product_class	The scale classes, for subclassing and dispatch
scale_rank	Frame rank
scale_read_payload	Write and read a subclass's payload in a definition file
scale_residuals	Units that are residuals
SCALE_RULES	Supported aggregation rules
scale_share	Weight shares within a frame
scale_units	Units of a NestedScale
scale_vocab	The dimension vocabulary of a scale
scale_weights	Weight columns of a NestedScale
scale_write_payload	Write and read a subclass's payload in a definition file
shipped_scales	Shipped definitions: 'carriers' and the IPCC 2006 fuel defaults
summary.NestedScale	Summarize a NestedScale
summary.nestedscales::NestedScale	Summarize a NestedScale
summary.nestedscales::ScaleProduct	Summarize a product
summary.ScaleProduct	Summarize a product

-- W --

write_scale	Write a scale as a definition file, and read one back
write_scale_dataset	Write data and the scales that index it to one folder

-- misc --

[.NestedScale	Subset a NestedScale
[.nestedscales::NestedScale	Subset a NestedScale