Download and Getting Started Instructions

Download and Install
  1. First install Docker onto your PC.  Installation instructions can be found at the following locations:

(Note: It may be necessary to enable hyper virtualization from the BIOS for some Windows based machines. See here for more details.)

  1. Check your Docker settings to ensure that you have enough memory allocated to run Pivot Billions.  (minimum 2 GB)
  2. Open a shell (for Windows 10 use Powershell or cmd.exe)
  3. Pull the Pivot Billions container from Docker:
    >docker pull auriqsystems/pivotbillions
    For docker on Windows, make sure to switch to Linux Containers in your settings, otherwise you will be unable to pull Pivot Billions.
  4. Run Pivot Billions
    >docker run -dit -p 80:3000 --name="pb" auriqsystems/pivotbillions /bin/bash
    >docker exec -d pb bash /home/start-server.sh
  5. Open a browser window and enter: http://localhost/index.html
  6. You should see the Pivot Billions UI in your browser
Importing Data
  1. Click on the plus symbol located in the upper right of the the data selection box to show data import options.
  2. The Drag & drop option lets you add files stored locally on your PC.  The From URL option lets you specify files accessible online by entering one or more URLs into an input box.
  3. After you've added your new data files either from local storage or from an online source, you will see the new data files in the data selection box.
Load Data to Reports
  1. From the Pivot Billions data selection box, select the Main data file you want to load from the selection list and then click on the Preview button.
  2. A preview of the columns will load beneath.  You can change the column labels or data type as well as select your data keys here.
  3. By default the Skip Errors option is selected.  This instructs Pivot Billions to skip rows with errors in them.  Click on the Import button to load the data.
  4. You should now see the report table with the selected sample data loaded.

    Once the sample data has been loaded, you can begin interacting and analyzing the data from the Report UI.
Sorts, Filters and Distributions
Sorting
  1. Hover over a column name in the Report table and click on the Sort icon     in the tools overlay.
  2. The selected column will initially sort in descending order.  Click the sort icon again to sort in ascending order.  The sort direction will be displayed next to the column name as shown below.
Filtering (Global) Applying global filters affect not only the main report table but any generated distribution graphs or pivot tables as well.
  1. Hover over a column name in the Report table and click on the Filter icon    in the tools overlay.
  2. The Filter Condition box will open allowing you to enter the criteria for your filter.  After inputting your filter criteria, click enter on your keyboard to implement. You can apply multiple filters across different data columns and within the same column (e.g. "Greater than 1" and "Less than 10")
  3. Filtered columns will display the filter symbol next to the column label.
  4. To change the Logical operation of filters (AND, OR), click on the Filter icon located in the header of the UI then click on the "and" text between the filter conditions.  This will toggle the logic from AND to OR.
  5. To delete or remove a filter, click on the (x) next to the filter condition to remove a single filter, or click on the trash icon to remove all filters.
Filtering (Local) Applying local filters affect only the distribution graphs or pivot tables that the filter is entered from.
  1. Within a distribution graph or pivot table, click on the plus symbol (+) found usually at the top of the table, chart or graph.
  2. Use the dropdowns and fields that appear to enter your filter conditions.
  3. Just like global filters, you can enter multiple local filters at the same time.  In addition, you can click on the "and" text to change the logic to an "or" condition.
  4. To remove any local filters, simply click on the (x) next to the filter condition.
Distribution Graphs
  1. Hover over a column name in the Report table and click on the Graph icon    in the tools overlay.
  2. Directly beneath the Report table, a Distribution graph will be generated based on the column data selected.  If the data is numeric, then the graph will show distribution of counts by range.  If the data is string, then the counts for each unique value will be shown. 
  3. Clicking on the Table icon will show the distribution data represented in table format.
  4. For string data, clicking on the Pie Chart icon  will show the distribution data as a pie chart.
Combining Multiple Files

Often times, the data you want to analyze might be split over multiple files.  In order to analyze all the data as a cohesive data set, you must first combine the files.  In Pivot Billions, you can combine data files that have the same schema or data structure by following these steps.

  1. From the data selection box, click on the check boxes for each file you want to combine under the Main heading.  In this case we are using the two New York taxi data files already included with Pivot Billions.
  2. Select the Preview button to view the column labels and data types and click Import when you are ready.
  3. The combined data files will be loaded into the report table.  Notice that the combined row count is twice that of a single data file.
  4. You can combine as many files as necessary, but please keep in mind that capacity and performance are dependent on your docker system resource settings.  For larger data sets, it may require that you allocate more memory and/or cpu to process efficiently.
Joining Files

When you have different types of data files that are connected through common keys, Pivot Billions allows you to Join these files in a left join fashion.  This is very useful if you want to integrate a lookup table to your primary data set.   In the following example, we will combine the two sample New York taxi data files and then join the taxi zone lookup table file located here to the combined data set.

To Join data, follow these steps:

  1. Import the taxi zone lookup file by entering the URL in the data selection box.  Click on the Go button to import the file.
  2. Once the lookup file has loaded, click on the check boxes under the Main heading for the taxi data as shown, and then click on the check box under the Join heading for the taxi zone lookup file you just loaded.
  3. Select the Preview button to view the column labels and data types.  Notice that there is a warning message above the schema preview that indicates there is no matching key column between the Main data set and the Join file.  In the Main data set, there is a column labeled PULocationID while in the Join data set there is a column labeled LocationID.
  4. Change the LocationID label in the Join data set to PULocationID as shown.  Notice that the warning message disappears after a matching Key column has been identified.
  5. Click on the Import button to load both the Main data set and the Join data set.  Once it has loaded into the report table, slide right until you see the newly joined data columns of Borough, Zone and service_zone.
  6. At this point you can now select these columns as dimensions for analysis in pivot tables, as well as perform all other report functions.  In this example we demonstrated joining one lookup table file, but you can Join multiple files as necessary following the same steps.
Analyzing Sample Data

There are two sample data sets provided with Pivot Billions Docker version.  One contains currency data and the other contain New York taxi data.  To load either follow these steps:

  1. From the Pivot Billions data selection box, select the file you want to load from the selection list.
  2. For this example select the green_tripdata_2017-01.csv.gz file, and then click on the Preview button.
  3. A preview of the columns will load beneath.  You can change the column labels or data type as well as select your data keys here.
  4. By default the Skip Errors option is selected.  This instructs Pivot Billions to skip rows with errors in them.  Click on the Import button to load the data.
  5. You should now see the report table with the selected sample data loaded.
  6. Once the sample data has been loaded, you can begin interacting and analyzing the data from the Report UI.  From here, you can sort, filter, add columns and create pivot tables.  The following steps goes through a basic exercise to show how to analyze the New York taxi sample data.

  7. Select the Column View Configuration icon and click on the Select None box.
  8. Click on the pickup_datetime, pickup_location_id, and trip_distance column labels and then click anywhere outside the configuration box.

    Your table should now show only the three columns selected.
  9. Click on the Add Column icon and enter the following:
    Label: ymd
    Format: string(s)
    ESS Syntax: substr(pickup_datetime,0,10)

    The settings shown above extracts the year-month-day from the original pickup_datetime column. For the purpose of our analysis, we don’t want to include the time information from the original column data.
  10. Save the new column.  Your table should now show four columns.
  11. Click on the Pivot icon and select pickup_location_id and ymd for your dimensions and select trip_distance for your value, then click View.
  12. A new table will be generated below with aggregated values for the selected dimensions.
  13. Click on the View Type icon to switch to Pivot View.
  14. Drag the pickup_location_id field label to the row area and then drag the ymd field to the columns area.
  15. Change the data value from Count to Summation.

    This changes the data value to the sum of all distances calculated for a pickup_location_id|ymd pair.
  16. Sort the pivot table by largest total value by clicking on the up down arrow until you see the up arrow.

    We see that the largest total trip_distances are associated with pickup_location_id’s of 74 and 255.
  17. Click on the pickup_location_id field label to see a list of field values, and choose Select None to deselect all the values.
  18. Next individually select 74 and 255 and click Apply.  Your pivot table should like like this:
  19. Click on the chart selection list and select the Line Chart option.
  20. You should now see a line chart of total trip distances logged per day for each pick up location id.

    Notice that 74 has a much more consistent and narrow range for distance, while 255 has a much wider range.  The large peaks for 255 are attributed to weekend pick ups.