Skip to content

Commit

Permalink
Add association assset naming convention to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bendnorman committed Nov 10, 2023
1 parent 19a9e7a commit 1d2d71c
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/dev/naming_conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,15 @@ Naming convention: ``core_{source}__{asset_type}_{asset_name}``
* ``asset_type`` describes how the asset is modeled and its role in PUDL’s
collection of core assets. There are a handful of table types in this layer:

* ``assn``: Association tables provide connections between entities. This data
can be manually compiled or extracted from data sources. If the asset associates
data from two sources, the source names should be included in the ``asset_name``
in alphabetical order. Examples:
* ``assn``: Association assets provide connections between entities. They should
follow this naming convention:

``{layer}_{source of association asset}__assn_{datasets being linked}_{entity
being linked}``

Association assets can be manually compiled or extracted from data sources. If
the asset associates data from two sources, the source names should be included
in the ``asset_name`` in alphabetical order. Examples:

* ``core_pudl__assn_plants_eia`` associates EIA Plant IDs and manually assigned
PUDL Plant IDs.
Expand Down

0 comments on commit 1d2d71c

Please sign in to comment.