quick link to WP3 FLR

General Documentation Process

First of all, the present EFIMAS DocuWiki under WP3 (as well as under WP4 and the general EFIMAS reporting from the wiki) gives a thorough description and documentation of FLR including its: a)background for establishment, b) context in fisheries science and advice, c) purpose, d) development, e)ability for use, f) structure and contents, g) application and implementation including tests and examples of use. Also, it give a comprehensive description of FLR workshops, FLR courses and tutorials as well as the comprehensive disseminaiton of the management evaluation framework established. Among other it includes reference to the scientific publications made in relaiton to development of FLR under EFIMAS and sister projects.

Under R USER developed sofware is made available as packages, where each FLR package contains documentation, tests and examples which includes:

  • help files on classes and methods called directly from R command window.
  • basic example code from those help pages. The relevant data needed to run those examples are included in the package.

In addition to the basic documentation, FLR proposes further help through the FLR wiki website.

  • The teach yourself FLR section contains well documented tutorials from the FLR introduction to more advanced modeling.
  • The numerous FLR courses that have been held in the frame of EU-projects are accessible online. They provide a general guideline to start with FLR, powerpoint presentations, pieces of code, examples of application.
  • The FLR package description web pages are especially informative, pdf manuals are available on most of them.

This allows everyone who is interested to learn easily the FLR basics from those pages and the intuitive aspect of R-programming makes the more advanced programming easy and quick. This is a living document and will be modified to reflect future developements after the completion of EFIMAS.

Core Group / users development structure

FLR aims at developing a common framework to facilitate collaboration within and between disciplines. It is mostly developed within EFIMAS and other EU funded research projects gathering most European fisheries institutes. In this regard, tools have been set up in order to facilitate the cooperation between users and developers and among developers:

  • The FLR users and FLR developers mailing-lists are good ways to be kept informed on the latest implementations, but they provide also an interactive help with the FLR-team, which is usually rapid to answer the interrogations and keen to guide beginners in the FLR world. Users only need to post their questions to the help mailing-list and wait for other users or developers to answer. This is a dynamic way of making the whole development process moving on by contributing at one's own measure.
  • In the same way, a FLR bug report system has been implemented in order to signal bugs detected in the FLR packages.

This is not only a way of promoting FLR to programming-reluctant people; it is also the opportunity of collaboration between scientists from different countries and disciplines.

Having many users participating to the development of FLR is actually one of the main aim of this approach. The FLR frame is “only” providing a tool-box, of which single elements can easily be assembled by the user in order to form an original model.

Documentation process in EFIMAS

FLR should be delivered with full documentation in the EFIMAS frame. The integration of the various models into FLR has been made possible thanks to the numerous FLR/R courses and FLR/R workshops held as well as for example the ECONOW workshops (see section 3.6). The common documentation written for each package is developed under EFIMAS as in all the EU-funded research projects in relation to FLR that have/had a link with FLR.

Katell Hamon 2007/02/01 14:30J. Rasmus Nielsen 2008/09/10 16:25

efimas1/wp3/3-3-3/main.txt · Last modified: 2008/09/10 16:39 by admin
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki