Parsing to the primary model

Overview

This page outlines our guidelines for parsing data from the raw file to the primary model.

Guidelines

Once the primary model is complete, the next step is to parse the raw file into the primary model. This is typically done in a function named parse_to_primary_model which takes the raw file as input and returns an instance of the primary model.

The parse_to_primary_model function should be the only function in the task script which directly interacts with the raw file. All other downstream functions should take the primary model, or part of it, as input.

File type specific parsing

For file-type specific parsing instructions, search for how to parse the given file type (txt, csv, excel, pdf, json, etc.) in this documentation section.