1 Overview

This document provides a detailed referrence of the functions used in CannuckFind. It has been documented as an html file to allow rapid lookup and to take full advantage to the Search features within Sphinx. Another key feature of Sphinx is the ability to embed tested working examples within the document. The fact that the output can be shown with the code provides an aid to developers in quality control as well as the assurance that the working examples in fact work. A usage document is available to provide the thinking behind the package.

This documents a library. As such, it is a collection of classes.

1.1 C3 class

This primary class allows the documentation of the comparisons between Canada, the US and the Rest of the world. Within this class there are a series of functions that can distinguish the country of origin of statements on social networks. In this version, the interface is layered over two popular libraries, GeoGrapy and SpaCy. Within this class there are numerous methods for identifying countries.

1.2 Unknown

A class to capture the reasons for unknown variables. This allows for the better analysis of incomplete datasets.