docs/guide.md

In JohnCoene/auritus: Open-Source Media Monitoring And Listening Platform

Quick Start

Install

auritus is written in R, the language must thus be installed on your machine.

Once installed, create a new project with the RStudio IDE, or create a directory where to host the app, open the R console and set the working directory to the one you just created with setwd().

Then run the following from the R console:

if(!"remotes" %in% row.names(installed.packages()))
  install.packages("remotes")

remotes::install_github("news-r/auritus", upgrade = "never")

The above will install the remotes package if it is not installed already then use the latter to install auritus from Github.

From source

You can install the package from source by first cloning the repository

git clone https://github.com/news-r/auritus.git

Then from the source directory:

if(!"devtools" %in% row.names(installed.packages()))
  install.packages("devtools")

devtools::install()

Once the auritus package installed, load it and follow the instructions below to initialise your project.

library(auritus)

Initialise

Initialise the configuration file, this function does not take any argument.

init_auritus()

This will create a file called _auritus.yml in the root of your directory.

Read the config before moving forward

Setup the _auritus.yml configuration file with your details or the following functions will return errors.

Setup

The setup function will perform sanity checks on your _auritus.yml file as well as setup a few things if necessary.

setup_auritus()

The setup_auritus function takes three arguments that are passed to crawl_data which is described below.s

The above command will prompt you to run an initial data crawl. If you do not accept then you must run the crawl yourself aftwerwards with:

crawl_data()

The crawl_data function takes three optional sarguments:

• days: The number of days of data to crawl, from the date the function is ran, defaults to the maximum 30.
• quiet: Whether to show helpful messages in the console during the crawl, defaults to FALSE.
• pages: Number of pages of results to query, defaults to 50, 1 page = 1 webhose.io query.

Launch

Once setup and data collected you can launch auritus with:

launch_auritus()

This will open the dashboard in your browser.

JohnCoene/auritus documentation built on March 12, 2020, 8:27 p.m.