README.md

In jagephart/fishrmap: Map fishery trade data

fishRmap

An interactive visualization and filtering tool for geospatial trade data tailored for use by SESYNC research groups.

Installation

Because this is currently a private repository, installation has an extra step or two:

1. Generate a SESYNC GitLab token
2. Run the code:

```{r install}

Install packages if needed

install.packages(c('devtools', 'httr'));

library(devtools); library(httr);

httr::set_config( config( ssl_verifypeer = 0L ));

devtools::install_github( 'ajulca/fishRmap', auth_user = '[your SESYNC GitLab username]', auth_token = '[The token you just made]', host = 'https://gitlab.sesync.org/api/v3' )

library(fishRmap)

Alternatively, it may be necessary to install from tarball:
```{r install2} 
install.packages('fishRmap_0.0.1.tar.gz', repos = NULL, type = 'source')

library(fishRmap)

Using the fishRmap function:

```{r use}

simple call:

fishRmap([either a 'String path to your data', or a data.frame])

call with modified column headers

fishRmap(myData, import = 'Import', export = 'Export', species = 'Species', value = 'value', year = 'Year', iso = 'numeric', importOnly = FALSE, exportOnly = FALSE)

view descriptions of possible parameters:

?fishRmap ```

For Developers

"fishRmap/R/" directory contains the R wrapper for the application

• fishRmap is the central function for the R interface to the application; the R script is primarily a wrapper for the JavaScript code contained in "fishRmap/inst/extdata/www/", although it also depends on api.R and fishUp.R
• fishUp is used to creat hard links in "[shiny library directory]/www/shared/fishRmap/" to files in "fishRmap/inst/extdata/www/"; this is used only indirectly through the fishRmap function
• api is used to transfer data back and forth from JS app; this is used only indirectly through the fishRmap function

"fishRmap/inst/extdata/www/" directory contains the bulk of the visualization's core code

The user does not interact with this directly, but it is where the developer will do most of their work. "js/fishRmap.js" is the primary script for the interface "js/api.js" is the correllary to api.R; this allows communication between client and "server" side "js/fishRmap.css" is main css file "build/" directory contains dependency libraries * "ajax/" directory contains geo/topojson data to be used for map

To build

jagephart/fishrmap documentation built on June 19, 2020, 12:15 a.m.