Skip to content

Reference

The functions of the Python binding, grouped as in the R reference. Names and argument order match R. See also the cross-language table.

  • Scales -- scale_from_leaftable, scale_example, scale_example2, NestedScale, scale_class, scale_product_class, scale_is, scale_is_product, scale_frames, scale_units, scale_key, scale_leaftable, scale_weights, scale_rank, scale_atom_level, scale_residuals, is_valid_frame, scale_summary
  • Navigation and shares -- scale_children, scale_parents, scale_descendants, scale_ancestors, scale_family, scale_ancestry, scale_nests, scale_crosses, scale_is_uniform, scale_share, scale_coverage
  • Subsetting -- filter_scale, prune_scale
  • Attributes and aliases -- attach_attributes_scale, scale_attributes, SCALE_ATTRIBUTE_KINDS, attach_aliases_scale, scale_aliases, scale_match, convert_scale
  • Conversion -- recast_scale, recast, recast_to_atoms, recast_from_atoms, recast_crosswalk, join_scale, SCALE_RULES, register_scale_rule, get_scale_rule, list_scale_rules, clear_scale_rules
  • Crosswalks -- scale_map, scale_map_between, register_scale_map, register_scale_map_between, get_scale_map, get_scale_map_between, list_scale_maps, clear_scale_maps
  • Products of scales -- scale_product, ScaleProduct, scale_axes, product_size, product_keys, product_frames, product_weights, product_coverage
  • Definitions and catalogue -- write_scale, read_scale, scale_catalog, register_scale_dir, list_scale_dirs, clear_scale_dirs
  • Arrays and storage -- as_scale_array, as_scale_table, write_scale_dataset, open_scale_dataset, scale_dataset_info
  • Building a dimension package -- scale_alias_property, scale_vocab, scale_payload_slice, scale_write_payload, scale_read_payload, register_scale_class, list_scale_classes, scale_atom_pairs, backend_bind_rows, backend_distinct, backend_is_lazy, backend_of, backend_pull, backend_restore, backend_scan, backend_schema
  • Python only -- ALIAS_SCHEMA, ATTR_SCHEMA, Backend, NestedScalesError, NestedScalesWarning, ScaleDataset, ScaleSummary, Verdict, empty_aliases, empty_attributes

R only

Not in the binding yet: reconcile_scale, product_atoms, recast_product, join_product, filter_product, cluster_scale, cluster_contiguous, cluster_medoids, cluster_sweep, scale_distance, SCALE_DISTANCES, register_scale_distance, shipped_scales, scale_payload_collapse.