[Stacomir-commits] r473 - pkg/stacomir

[noreply at r-forge.r-project.org]

Author: legrand
Date: 2018-02-06 15:32:40 +0100 (Tue, 06 Feb 2018)
New Revision: 473

Modified:
   pkg/stacomir/README.Rmd
   pkg/stacomir/README.md
Log:
correction on list items + suppression of "toc: TRUE" in the beginning of the doc

Modified: pkg/stacomir/README.Rmd
===================================================================
--- pkg/stacomir/README.Rmd	2018-02-05 15:54:34 UTC (rev 472)
+++ pkg/stacomir/README.Rmd	2018-02-06 14:32:40 UTC (rev 473)
@@ -1,8 +1,8 @@
 ---
 title: StacomiR
-author: Marion Legrand, Cédric Briand
+author: Marion Legrand, Cédric Briand
 output: github_document
-toc: true
+
 ---  
 
 
@@ -95,19 +95,29 @@
 #### Dams
 The concept of dam used in the context of fish migration monitoring database
 refers to a system blocking or guiding the migratory flow like : 
+
 * weir, 
+
 * electric guide barrier, 
+
 * netting dam, 
+
 * etc.
 
+
 #### Crossing device   
 A crossing device (DF) is a passageway that allows and concentrates the
 migratory flow between upstream and downstream sections of a dam. They can be of
-various type
+various type :
+
 * fishway, 
+
 * spillway, 
+
 * fish elevator,
+
 * eel trapping ladder, 
+
 * etc.
 
 It is possible to have more than one crossing device on a same dam.
@@ -115,9 +125,13 @@
 #### Counting device
 A counting device (DC) is a set of equipment installed on a crossing device used
 to monitor fish migration. It can be :
+
 * a video counting device, 
+
 * a trap, 
+
 * an accoustic counting device, 
+
 * ...
 
 
@@ -149,11 +163,17 @@
 method*, or plot results. 
 For instance, the migration report class comprises slots for :
 ***
+
 * DC The counting device (camera, trap, acoustic device...)
+
 * taxa The species list from the database and the taxa selected
+
 * stage The stages list from the database and the stage selected
+
 * starting date The date of beginning
+
 * ending date The last date of the report
+
 ***
 Read the help files e.g. `? report_mig` to get documentation on the following
 classes.

Modified: pkg/stacomir/README.md
===================================================================
--- pkg/stacomir/README.md	2018-02-05 15:54:34 UTC (rev 472)
+++ pkg/stacomir/README.md	2018-02-06 14:32:40 UTC (rev 473)
@@ -1,9 +1,7 @@
 StacomiR
 ================
-Marion Legrand, Cédric Briand
+Marion Legrand, Cédric Briand
 
-true
-
 [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/stacomiR)](https://cran.r-project.org/package=stacomiR)
 
 # stacomiR <img src="man/figures/logo.png" align="right" />
@@ -82,23 +80,47 @@
 
 The concept of dam used in the context of fish migration monitoring
 database refers to a system blocking or guiding the migratory flow like
-: \* weir, \* electric guide barrier, \* netting dam, \* etc.
+:
 
+  - weir,
+
+  - electric guide barrier,
+
+  - netting dam,
+
+  - etc.
+
 #### Crossing device
 
 A crossing device (DF) is a passageway that allows and concentrates the
 migratory flow between upstream and downstream sections of a dam. They
-can be of various type \* fishway, \* spillway, \* fish elevator, \* eel
-trapping ladder, \* etc.
+can be of various type :
 
+  - fishway,
+
+  - spillway,
+
+  - fish elevator,
+
+  - eel trapping ladder,
+
+  - etc.
+
 It is possible to have more than one crossing device on a same dam.
 
 #### Counting device
 
 A counting device (DC) is a set of equipment installed on a crossing
-device used to monitor fish migration. It can be : \* a video counting
-device, \* a trap, \* an accoustic counting device, \* …
+device used to monitor fish migration. It can be :
 
+  - a video counting device,
+
+  - a trap,
+
+  - an accoustic counting device,
+
+  - …
+
 #### Monitoring operation
 
 An operation corresponds to a monitoring of a counting device during a
@@ -127,12 +149,22 @@
 classes* are built from referential classes and have different methods
 to access the database *connect methods*, generate calculations *calcule
 method*, or plot results. For instance, the migration report class
-comprises slots for : *** * DC The counting device (camera, trap,
-acoustic device…) \* taxa The species list from the database and the
-taxa selected \* stage The stages list from the database and the stage
-selected \* starting date The date of beginning \* ending date The last
-date of the report **\* Read the help files e.g. `? report_mig` to get
-documentation on the following
+comprises slots for : \*\*\*
+
+  - DC The counting device (camera, trap, acoustic device…)
+
+  - taxa The species list from the database and the taxa selected
+
+  - stage The stages list from the database and the stage selected
+
+  - starting date The date of beginning
+
+  - ending date The last date of the report
+
+-----
+
+Read the help files e.g. `? report_mig` to get documentation on the
+following
 classes.
 
 | Class                    | Command                         | description                         |