Returns the build record an atlas carries, or NULL for an atlas built
before provenance existed or by a pipeline that did not record one.
Value
A named list, or NULL. When present it carries at least
pipeline (what built the atlas, including its version) and created
(when). Any further fields are the producing pipeline's own, commonly the
source parcellation and the arguments the build was given.
Details
Provenance answers a question the rest of the class cannot: not what the atlas contains, but how it came to contain it. Two atlases produced by the same pipeline can differ in view count, polygon simplification or palette source because they were built with different arguments, and without a record the only way to find out is to locate the build script that produced them – which lives in a different repository and may have changed since.
See also
set_atlas_provenance() to attach one.
Other atlas accessors:
atlas_centerlines(),
atlas_context(),
atlas_display(),
atlas_geom(),
atlas_geometry_type(),
atlas_hemi(),
atlas_labels(),
atlas_meshes(),
atlas_palette(),
atlas_plot_palette(),
atlas_polygons(),
atlas_region_semantics(),
atlas_regions(),
atlas_sf(),
atlas_type(),
atlas_undrawn(),
atlas_vertices(),
atlas_views(),
atlas_views_empty(),
legacy_region_map()
Examples
atlas_provenance(dk())
#> NULL
