Data-flo's building blocks: Adaptors

What is an adaptor?

An adaptor is a step in a workflow that performs a specific task such as reformatting a date column, adding jittering for statistical analysis, importing datasets, geocoding places, or sampling data from a datatable.

In the Data-flo canvas, an adaptor is represented by a card. Behind the scenes, an adaptor consists of a JavaScript function and a metadata manifest, wrapped up and presented as a card in the Data-flo interface.

Format-date-column adaptor card

There are three categories of adaptor. Follow the links below to read more about each type:

1. Import adaptors: to bring data into Data-flo from external data sources or uploaded data files

2. Transformation adaptors: to perform all necessary manipulations on the data

3. Export adaptors: to make data available outside of Data-flo

How do adaptors work?

Adaptors come pre-programmed. Using the side bar menu on the canvas, you may add adaptors to your canvas to start importing and transforming your data.

Simply add an adaptor to your canvas and specify the input arguments to transform the data into your desired format. Once you are happy with your transformed data, you will add an export adaptor to the canvas to transfer your data to another platform or file format.

Adaptor arguments

An adaptor's arguments are variables that affect the adaptor's outcome. They define the specifics of the Javascript function underlying the adaptor, allowing the adaptor to transform data. Each argument is listed on the adaptor card.

Each adaptor requires input arguments from the user in order for it to function in a tailored or customised way. These inputs are called input arguments and may include the column name, original + new format, sampling method, etc. These input arguments allow users to parameterize how the adaptor works for their unique needs and data structure.

Input arguments appear on the left side column of every adaptor. Select in the side bar menu to specify a custom format or value.

The adaptor’s output(s) appear on the right side column of each adaptor card. Clicking the output button will show the user how the adaptor transformed the dataset.

Accessing support/ guidance on how to use adaptors

Before adding an adaptor to your canvas, select the question mark icon to review detailed guidance for using that adaptor.

Alternatively see our comprehensive Adaptor Reference Guide for a complete list of all adaptors along with details on their input arguments, examples, and recommended use cases.