Giter VIP home page Giter VIP logo

mfdb's Introduction

MFDB: Data management for fisheries model creation

CRAN version badge CRAN Checks CRAN RStudio mirror total downloads badge CRAN RStudio mirror monthly downloads badge R-CMD-check

This package enables automated processing of fisheries data into suitable forms for running ecosystem models against it, e.g. GADGET.

This package contains several distinct sets of functions:

  • Create and connect to a PostgreSQL database schema (mfdb function)
  • Import data into a PostgreSQL database (mfdb_import_* functions)
  • Sample / group data from database (other mfdb_* functions)
  • Manage GADGET model directories and export data into them (gadget_* functions)

Using this, you can install PostgreSQL locally and have a script automating the process of:

  1. Importing data from your sources
  2. Uploading into your local MFDB database
  3. Sampling / grouping this data
  4. Producing set of GADGET model files ready to be run by GADGET

Also, this libary can be used to connect to a remote database and generate model files from that data.

This work is based on it's predecessor, DST^2.

Prerequisites

Besides R, you will also need RPostgres set up to access the database, and PostgreSQL installed if you want to run the database locally too.

Linux (Debian / Ubuntu)

Installation of RPostgres will happen automatically, however you need some PostgreSQL libraries before it will work:

apt-get install libpq-dev

Also, you can install the postgresql package using:

apt-get install postgresql

Some additional instructions are available here: https://wiki.debian.org/PostgreSql

Now, create an mf database that the user on your computer owns:

$ echo $USER  # Check to see who you are, I'm lentinj
lentinj
$ su
# su - postgres
$ psql
postgres=# CREATE USER lentinj;
postgres=# CREATE DATABASE mf OWNER lentinj;

Linux (Redhat / Fedora)

Installation of RPostgres will happen automatically, however you need some PostgreSQL libraries before it will work:

yum install postgresql-devel

Also, you can install the postgresql package using:

yum install postgresql-server

Some additional instructions are available here: https://fedoraproject.org/wiki/PostgreSQL and some tips when troubleshooting CentOS installations can be found at: http://stackoverflow.com/questions/17633422/psql-fatal-database-user-does-not-exist

Now, create an mf database that the user on your computer owns:

$ echo $USER  # Check to see who you are, I'm lentinj
lentinj
$ su
# su - postgres
$ psql
postgres=# CREATE USER lentinj
postgres=# CREATE DATABASE mf OWNER lentinj;

Microsoft Windows

To install PostgreSQL, download version 9.5 of the database installer from here:

https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

Find the psql shell (SQL shell) in the start menu, and create both an mf database and user:

postgres=# CREATE USER mf PASSWORD 'mf';
postgres=# CREATE DATABASE mf OWNER mf;

Apple OS X

Install using http://postgresapp.com/

Create a database called mf.

Installing

You can install from CRAN:

install.packages('mfdb')

Or use remotes to install this directly:

# install.packages("remotes")
remotes::install_github("gadget-framework/mfdb")

Using

For an introduction to the package, read the package?mfdb help file in R. This is also available online.

There are a selection of example scripts in the demo/ folder. The example-* scripts show the full process of importing data from specified sources into the database, then querying this to aggregate into various gadget model files. The inttest-* scripts demonstrate other aspects, and also function as tests to ensure that the library works correctly (thus the ok() function calls).

Finally, there is documentation on the database schema.

Development

Running integration tests

Given the database is setup as above, integration tests and all package examples can be run with make inttest.

To run all tests (unit tests, integration, examples and check-as-cran), use make.

Models using MFDB

Acknowledgements

This project has received funding from the European Union’s Seventh Framework Programme for research, technological development and demonstration under grant agreement no.613571.

mfdb's People

Contributors

lentinj avatar bthe avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.