From fdf92006147d576ec6036a610191d8f1f0b37046 Mon Sep 17 00:00:00 2001 From: martincox Date: Wed, 1 May 2024 11:27:07 +1000 Subject: [PATCH 1/2] pkgdown --- .Rbuildignore | 4 +++ .github/.gitignore | 1 + .github/workflows/pkgdown.yaml | 48 ++++++++++++++++++++++++++++++++++ .gitignore | 1 + DESCRIPTION | 2 +- _pkgdown.yml | 4 +++ 6 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 .github/.gitignore create mode 100644 .github/workflows/pkgdown.yaml create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index 91114bf..91fb891 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,2 +1,6 @@ ^.*\.Rproj$ ^\.Rproj\.user$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..a7276e8 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,48 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + release: + types: [published] + workflow_dispatch: + +name: pkgdown + +jobs: + pkgdown: + runs-on: ubuntu-latest + # Only restrict concurrency for non-PR jobs + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index c834446..a139abc 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .Rhistory .RData *~ +docs diff --git a/DESCRIPTION b/DESCRIPTION index 34458d6..c17fa5f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -8,7 +8,7 @@ Authors@R: c(person("Martin", "Cox", email = "martin.cox@aad.gov.au", role = c(" Description: Automation of active acoustic data processing by controlling Echoview (R) using Component Object Model (COM) scripting. Echoview (R) is a registered trademark of Echoview Software Pty Ltd. Website: www.echoview.com/ License: GPL-3 -URL: https://github.com/AustralianAntarcticDivision/EchoviewR +URL: https://github.com/AustralianAntarcticDivision/EchoviewR, http://australianantarcticdivision.github.io/EchoviewR/ BugReports: https://github.com/AustralianAntarcticDivision/EchoviewR/issues Depends: RDCOMClient diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..121f95d --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: http://australianantarcticdivision.github.io/EchoviewR/ +template: + bootstrap: 5 + From 37f14da77239a7812b5a8f9218776686ea5f97e3 Mon Sep 17 00:00:00 2001 From: martincox Date: Tue, 14 May 2024 12:27:39 +1000 Subject: [PATCH 2/2] pkgdown --- docs/LICENSE.html | 155 +-- docs/articles/Getting_Started.html | 686 +++++----- docs/articles/index.html | 165 +-- docs/authors.html | 200 +-- docs/index.html | 225 ++-- docs/pkgdown.js | 186 +-- docs/pkgdown.yml | 12 +- docs/reference/CCAMLR_SWARMR04.EV.html | 188 +-- docs/reference/EVAcoVarNameFinder.html | 241 ++-- docs/reference/EVAddCalibrationFile.html | 248 ++-- docs/reference/EVAddRawData.html | 250 ++-- docs/reference/EVAddVariable.html | 257 ++-- docs/reference/EVAdjustDataRngBitmap.html | 248 ++-- docs/reference/EVBottomDetection.html | 364 +++--- docs/reference/EVChangeVariableGrid.html | 370 +++--- docs/reference/EVClearRawData.html | 238 ++-- docs/reference/EVCloseFile.html | 232 ++-- docs/reference/EVCreateEditableLine.html | 282 ++--- docs/reference/EVCreateFileset.html | 238 ++-- docs/reference/EVCreateNew.html | 300 ++--- docs/reference/EVDeleteLine.html | 242 ++-- docs/reference/EVDeleteRegionClass.html | 240 ++-- docs/reference/EVExportEchogramToImage.html | 242 ++-- .../EVExportIntegrationAllRegions.html | 229 ++-- .../reference/EVExportIntegrationByCells.html | 250 ++-- .../EVExportIntegrationByRegionByCells.html | 253 ++-- docs/reference/EVExportLineAsCSV.html | 234 ++-- docs/reference/EVExportRegionDef.html | 246 ++-- docs/reference/EVExportRegionDefByClass.html | 242 ++-- docs/reference/EVExportRegionSv.html | 256 ++-- docs/reference/EVExportUnderlying.html | 260 ++-- docs/reference/EVExportWBST_FR.html | 288 ++--- docs/reference/EVFilesInFileset.html | 238 ++-- docs/reference/EVFindFilesetByName.html | 238 ++-- docs/reference/EVFindFilesetTime.html | 242 ++-- docs/reference/EVFindLineByName.html | 238 ++-- docs/reference/EVFindRegionByName.html | 240 ++-- docs/reference/EVFindRegionClass.html | 236 ++-- docs/reference/EVFishTracking.html | 410 +++--- docs/reference/EVGetCalibrationFileName.html | 238 ++-- docs/reference/EVImportLine.html | 235 ++-- docs/reference/EVImportRegionDef.html | 250 ++-- .../EVIntegrationByRegionsByCellsExport.html | 269 ++-- .../EVIntegrationByRegionsExport.html | 269 ++-- .../EVLineExportFromAcousticVarEVL.html | 264 ++-- docs/reference/EVNewAcousticVar.html | 248 ++-- docs/reference/EVNewFile.html | 230 ++-- docs/reference/EVNewFixedDepthLine.html | 248 ++-- docs/reference/EVNewLineRelativeRegion.html | 295 ++--- docs/reference/EVNewRegionClass.html | 238 ++-- docs/reference/EVOpenFile.html | 230 ++-- docs/reference/EVPingSubset.html | 249 ++-- docs/reference/EVRegionClassFinder.html | 238 ++-- docs/reference/EVRenameAcousticVar.html | 221 ++-- docs/reference/EVRenameLine.html | 248 ++-- docs/reference/EVResampleByPingControl.html | 249 ++-- docs/reference/EVSTWideband.html | 310 ++--- docs/reference/EVSaveAsFile.html | 238 ++-- docs/reference/EVSaveFile.html | 232 ++-- docs/reference/EVSchoolsDetSet.html | 312 ++--- docs/reference/EVSchoolsDetect.html | 353 +++--- docs/reference/EVSetAcoVarDisplayDepth.html | 250 ++-- docs/reference/EVShiftRegionDepth.html | 264 ++-- docs/reference/EVShiftRegionTime.html | 291 ++--- docs/reference/EVVersion.html | 220 ++-- docs/reference/EVmaxThresholdSet.html | 256 ++-- docs/reference/EVminThresholdSet.html | 240 ++-- docs/reference/EVsetExclusionLines.html | 247 ++-- docs/reference/EVsingleTargetPars.html | 282 ++--- .../EVsplitBeamSingleTargetPars.html | 264 ++-- docs/reference/QuitEchoview.html | 232 ++-- docs/reference/StartEchoview.html | 212 +--- docs/reference/centreLawnOnPosition.html | 271 ++-- docs/reference/centreZigZagOnPosition.html | 280 ++--- docs/reference/combineEVL.html | 205 +-- docs/reference/exportMIF.html | 258 ++-- docs/reference/getRaws.html | 305 ++--- docs/reference/index.html | 1109 ++++++++--------- docs/reference/jhF.html | 285 ++--- docs/reference/jhMultipleStrataF.html | 262 ++-- docs/reference/lawnSurvey.html | 303 ++--- docs/reference/makeEVRfromDT.html | 328 ++--- docs/reference/makeRectRegion.html | 313 ++--- docs/reference/modifyECS.html | 292 ++--- docs/reference/msDATEConversion.html | 205 +-- docs/reference/readUnderlyingDataCSV.html | 268 ++-- docs/reference/readevl2R.html | 207 +-- docs/reference/schoolRelativeDimension.html | 245 ++-- docs/reference/writeRevl2file.html | 213 +--- docs/reference/zigzagSurvey.html | 359 +++--- 90 files changed, 8978 insertions(+), 15061 deletions(-) diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 8713337..4990abc 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -1,140 +1,77 @@ - - - - - - - -NA • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - +NA • EchoviewR + Skip to contents + +
-
-
-

NA

+
+

NA

+ Source: LICENSE.md

This file is part of EchoviewR.

EchoviewR is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EchoviewR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

-

You should have received a copy of the GNU General Public License along with EchoviewR. If not, see http://www.gnu.org/licenses/.

+

You should have received a copy of the GNU General Public License along with EchoviewR. If not, see http://www.gnu.org/licenses/.

-
+
-
- -
-
+

Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

-
-

Site built with pkgdown.

+
+

Site built with pkgdown 2.0.9.

-
-
+
+ + - - + diff --git a/docs/articles/Getting_Started.html b/docs/articles/Getting_Started.html index 7cee757..516e420 100644 --- a/docs/articles/Getting_Started.html +++ b/docs/articles/Getting_Started.html @@ -1,97 +1,95 @@ - + - + + Getting started with EchoviewR • EchoviewR - - - - - - - + + + + -
-
-
-
-

Getting started with EchoviewR

-

Sven Gastauer

+ + + +
+
+

Getting started with EchoviewR

+

Sven +Gastauer

-

2018-11-01

+

2024-05-14

- Source: vignettes/Getting_Started.Rmd - - + Source: vignettes/Getting_Started.Rmd +
Getting_Started.Rmd
-
-

-EchoviewR

-

EchoviewR is an R package, distributed freely via GitHub. EchoviewR allows the user to easily access and automate some of the functionality included in Echoview through simplification of COM scripting.
+

+

EchoviewR +

+

EchoviewR is an R package, distributed freely via GitHub. +EchoviewR allows the user to easily access and automate +some of the functionality included in Echoview through simplification of +COM +scripting.
Main benefits of EchoviewR:

  • Automated processing of large amount of data files
    @@ -102,19 +100,33 @@

  • Integration of Echoview funcitonality into R
-

EchoviewR is not a replacement for Echoview, on the contrary, in order to be able to use EchoviewR you will have to have Echoview installed on your local machine with a valid user licence including the scripting module.

-

For more information on EchoviewR, please refer to the original paper introducing EchoviewR

-
-

-Help and Support

-

If you need help with a specific EchoviewR function, generally it is a good idea to check the description. The help for any function within EchoviewR can be accessed within R (for example help about the bottom detection function can be accessed as ?EVBottomDetection).
EchoviewR contains some vignettes, acting as extended documentation. Vigenettes are best viewed in a browser (e.g. Chromium, Opera, Firefox or Chrome). To browse vignettes in your preferred browser use:

-
browseVignettes("EchoviewR")
-

If you need further support or are missing some functionality in EchoviewR, please comment or make a feature erquest on GitHub.

+

EchoviewR is not a replacement for Echoview, on +the contrary, in order to be able to use EchoviewR you will have to have +Echoview installed on your local machine with a valid user licence +including the scripting module.

+

For more information on EchoviewR, please refer to the original +paper introducing EchoviewR

+
+

Help and Support +

+

If you need help with a specific EchoviewR function, +generally it is a good idea to check the description. The help for any +function within EchoviewR can be accessed within R (for example help +about the bottom detection function can be accessed as +?EVBottomDetection).
EchoviewR contains some vignettes, acting as extended +documentation. Vigenettes are best viewed in a browser (e.g. Chromium, +Opera, Firefox or Chrome). To browse vignettes in your preferred browser +use:

+
+browseVignettes("EchoviewR")
+

If you need further support or are missing some functionality in +EchoviewR, please comment or make a feature erquest on GitHub.

-
-
-
-
+

Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

-
-

Site built with pkgdown.

+
+

Site built with pkgdown 2.0.9.

-
+
+ + diff --git a/docs/articles/index.html b/docs/articles/index.html index fd22024..7d1e84b 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,139 +1,80 @@ - - - - - - - -Articles • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - +Articles • EchoviewR + Skip to contents + +
-
-
-

Articles

+
+

Articles

All vignettes

-

+
- -
-
-
+
Broadband SIngle Targets
+
+
Getting started with EchoviewR
+
+
EchoviewR - Basic Functionality
+
+
+
-
-
+ +

Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

-
-

Site built with pkgdown.

+
+

Site built with pkgdown 2.0.9.

-
-
+
+ + - - + diff --git a/docs/authors.html b/docs/authors.html index fd8388f..b376773 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,120 +1,76 @@ - - - - - - - -Citation and Authors • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - +Authors and Citation • EchoviewR + Skip to contents + +
-
-
-

Citation

+
+

Authors and Citation

-

Harrison LK, Cox MJ, Skaret G, Harcourt R (2015). -“The R package EchoviewR for automated processing of active acoustic data using Echoview.” -Frontiers in Marine Science, 2(15). -doi: 10.3389/fmars.2015.00015. -

- 
@Article{,
+    

+      
Authors

+      
+      
  • 
+          
    Martin Cox. Author, maintainer. 
+          
    
+        
    • 
+        
  • 
+          
    Sven Gastauer. Author. 
+          
    
+        
    • 
+        
  • 
+          
    Lisa-Marie Harrison. Author. 
+          
    
+        
    • 
+      

+
+    

+      
Citation

+      
Source: inst/CITATION

+
+      
Harrison LK, Cox MJ, Skaret G and Harcourt R (2015). The {R} package EchoviewR for automated processing of active acoustic data using Echoview. Frontiers in Marine Science, 2:15, doi: 10.3389/fmars.2015.00015

+      
@Article{,
   title = {The R package EchoviewR for automated processing of active acoustic data using Echoview},
   author = {Lisa-Marie K Harrison and Martin J Cox and Georg Skaret and Robert Harcourt},
   journal = {Frontiers in Marine Science},
@@ -123,44 +79,24 @@ 
Citation

   number = {15},
   doi = {10.3389/fmars.2015.00015},
 }

-    

-      
Authors

     

-
-    
    
-      
  • 
-        
    Martin Cox. Author, maintainer. 
-        
    
-      
    • 
-      
  • 
-        
    Sven Gastauer. Author. 
-        
    
-      
    • 
-      
  • 
-        
    Lisa-Marie Harrison. Author. 
-        
    
-      
    • 
-    

-
-  

-
-
+
-
-
+

Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

-
-

Site built with pkgdown.

+
+

Site built with pkgdown 2.0.9.

-
-
+
+ + - - + diff --git a/docs/index.html b/docs/index.html index a752d64..e0fcc1e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,164 +1,157 @@ - + - + + Control of Echoview via COM • EchoviewR - - - - - - - + + + + -
-
-
-
-

-EchoviewR

+
+
+
+

EchoviewR +

The R package EchoviewR - a free interface between Echoview (R) and R using COM scripting.

Copyright and Licence

-
Copyright (C) 2015 Lisa-Marie Harrison, Martin Cox, Georg Skaret and Rob Harcourt.
-
-This file is part of EchoviewR.
-
-EchoviewR is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-EchoviewR is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with EchoviewR.  If not, see <http://www.gnu.org/licenses/>.
+
Copyright (C) 2015 Lisa-Marie Harrison, Martin Cox, Georg Skaret and Rob Harcourt.
+
+This file is part of EchoviewR.
+
+EchoviewR is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+EchoviewR is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with EchoviewR.  If not, see <http://www.gnu.org/licenses/>.

This package is open for community development and we encourage users to extend the package as they need. We are not liable for any losses when using EchoviewR.

If using EchoviewR, please cite as:

{r citation} citation('EchoviewR')

-
-

-Installing EchoviewR

+
+

Installing EchoviewR +

Currently, EchoviewR has quite a few dependencies, something we are hoping to rectify. Meanwhile, you will need to install the following R packages:

sp,geosphere,maptools,RDCOMClient and lubridate

You can install all these packages with the following R code:

{r dependPacks,eval=FALSE} install.packages(c('sp','geosphere','maptools','RDCOMClient','lubridate'))

-

If RDCOMClient fails try: {r dependPacks, eval=FALSE} devtools::install_github("omegahat/RDCOMClient")

-

If the install still fails because of Rtools go to [https://cran.r-project.org/bin/windows/Rtools/] and install the latest version of Rtools. Once Rtools is installed, you have to restart RStudio and then install RDCOMClient before proceeding to install EchoviewR.

+

If RDCOMClient fails or if Echoview is crashing more frequently then exprected when using EchoviewR (likely behaviour for R > v4.x):

+

Please install RDCOMClient through (see for details):
{r dependPacks, eval=FALSE} install.packages("RDCOMClient", repos = "http://www.omegahat.net/R", type = "win.binary")
+or
{r dependPacks, eval=FALSE} devtools::install_github("omegahat/RDCOMClient")

+

In older versions of R it was recommended to install RDCOMClient through (see for details):

+

{r altRDCOMClient, eval=FALSE} devtools::install_github("dkyleward/RDCOMClient")

+

It is expected that the CRAN version of the issues RDCOMClient will be fixed in the near future.

+

If the install still fails because of Rtools go to [https://cran.r-project.org/bin/windows/Rtools/] and install the latest version of Rtools. Once Rtools is installed, you have to restart RStudio and then install RDCOMClient before proceeding to install EchoviewR.

You are then ready to install the EchoviewR package directly from github using devtools (Wickham & Chang, 2016):

-

{r install,eval=FALSE} if (!requireNamespace("devtools",quietly=TRUE)) install.packages("devtools") devtools::install_github('AustralianAntarcticDivision/EchoviewR')

+

{r install,eval=FALSE} if (!requireNamespace("devtools",quietly=TRUE)) install.packages("devtools") # Latest devtools syntax devtools::install_github("AustralianAntarcticDivision/EchoviewR", build_opts = c("--no-resave-data", "--no-manual")) ## For devtools v < 2.0 # devtools::install_github("AustralianAntarcticDivision/EchoviewR", build_vignettes = TRUE, force_deps=TRUE)

NB if you would like the older EchoviewR version (v1.0) that was used during the 2017 meeting of the CCAMLR Subgroup on Acoustics, Survey and Analysis Methods, please use the following code:

{r installASAM,eval=FALSE} devtools::install_github('AustralianAntarcticDivision/EchoviewR',ref='v1.0')

You should then be ready to work with EchoviewR: {r startEVR, eval=FALSE} library(EchoviewR)

-
-

-Getting started

-

We are currently updating the EchoviewR vignettes. Once available, the vignettes will use data available at the Australian Antarctic Division Data Centre [doi: http://dx.doi.org/10.4225/15/54CF081FB955F].

+
+

Getting started +

+

We are currently updating the EchoviewR vignettes. Once available, the vignettes will use data available at the Australian Antarctic Division Data Centre [doi: http://dx.doi.org/10.4225/15/54CF081FB955F].

-
-

-Acknowledgements

+
+

Acknowledgements +

The authors would like to thank Echoview (R) for their help and support during the development of this R package.

-

Echoview (R) is a registered trademark of Echoview Software Pty Ltd. Website: www.echoview.com/

+

Echoview (R) is a registered trademark of Echoview Software Pty Ltd. Website: www.echoview.com/

-
-

-References

-

Hadley Wickham and Winston Chang (2017). devtools: Tools to Make Developing R Packages Easier. R package version 1.34.4. https://CRAN.R-project.org/package=devtools

+
+

References +

+

Hadley Wickham and Winston Chang (2017). devtools: Tools to Make Developing R Packages Easier. R package version 1.34.4. https://CRAN.R-project.org/package=devtools

-
- -
+ + +
-
+

Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

-
-

Site built with pkgdown.

+
+

Site built with pkgdown 2.0.9.

-
+
+ + diff --git a/docs/pkgdown.js b/docs/pkgdown.js index de9bd72..9bd6621 100644 --- a/docs/pkgdown.js +++ b/docs/pkgdown.js @@ -2,87 +2,45 @@ (function($) { $(function() { - $("#sidebar") - .stick_in_parent({offset_top: 40}) - .on('sticky_kit:bottom', function(e) { - $(this).parent().css('position', 'static'); - }) - .on('sticky_kit:unbottom', function(e) { - $(this).parent().css('position', 'relative'); - }); + $('nav.navbar').headroom(); - $('body').scrollspy({ - target: '#sidebar', - offset: 60 + Toc.init({ + $nav: $("#toc"), + $scope: $("main h2, main h3, main h4, main h5, main h6") }); - $('[data-toggle="tooltip"]').tooltip(); - - var cur_path = paths(location.pathname); - var links = $("#navbar ul li a"); - var max_length = -1; - var pos = -1; - for (var i = 0; i < links.length; i++) { - if (links[i].getAttribute("href") === "#") - continue; - var path = paths(links[i].pathname); - - var length = prefix_length(cur_path, path); - if (length > max_length) { - max_length = length; - pos = i; - } - } - - // Add class to parent
  • , and enclosing
  • if in dropdown - if (pos >= 0) { - var menu_anchor = $(links[pos]); - menu_anchor.parent().addClass("active"); - menu_anchor.closest("li.dropdown").addClass("active"); - } - }); - - function paths(pathname) { - var pieces = pathname.split("/"); - pieces.shift(); // always starts with / - - var end = pieces[pieces.length - 1]; - if (end === "index.html" || end === "") - pieces.pop(); - return(pieces); - } - - function prefix_length(needle, haystack) { - if (needle.length > haystack.length) - return(0); - - // Special case for length-0 haystack, since for loop won't run - if (haystack.length === 0) { - return(needle.length === 0 ? 1 : 0); + if ($('#toc').length) { + $('body').scrollspy({ + target: '#toc', + offset: $("nav.navbar").outerHeight() + 1 + }); } - for (var i = 0; i < haystack.length; i++) { - if (needle[i] != haystack[i]) - return(i); - } + // Activate popovers + $('[data-bs-toggle="popover"]').popover({ + container: 'body', + html: true, + trigger: 'focus', + placement: "top", + sanitize: false, + }); - return(haystack.length); - } + $('[data-bs-toggle="tooltip"]').tooltip(); /* Clipboard --------------------------*/ function changeTooltipMessage(element, msg) { - var tooltipOriginalTitle=element.getAttribute('data-original-title'); - element.setAttribute('data-original-title', msg); + var tooltipOriginalTitle=element.getAttribute('data-bs-original-title'); + element.setAttribute('data-bs-original-title', msg); $(element).tooltip('show'); - element.setAttribute('data-original-title', tooltipOriginalTitle); + element.setAttribute('data-bs-original-title', tooltipOriginalTitle); } - if(Clipboard.isSupported()) { + if(ClipboardJS.isSupported()) { $(document).ready(function() { - var copyButton = ""; + var copyButton = ""; - $(".examples, div.sourceCode").addClass("hasCopyButton"); + $("div.sourceCode").addClass("hasCopyButton"); // Insert copy buttons: $(copyButton).prependTo(".hasCopyButton"); @@ -91,20 +49,108 @@ $('.btn-copy-ex').tooltip({container: 'body'}); // Initialize clipboard: - var clipboardBtnCopies = new Clipboard('[data-clipboard-copy]', { + var clipboard = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { - return trigger.parentNode.textContent; + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); - clipboardBtnCopies.on('success', function(e) { + clipboard.on('success', function(e) { changeTooltipMessage(e.trigger, 'Copied!'); e.clearSelection(); }); - clipboardBtnCopies.on('error', function() { + clipboard.on('error', function(e) { changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); }); + }); } + + /* Search marking --------------------------*/ + var url = new URL(window.location.href); + var toMark = url.searchParams.get("q"); + var mark = new Mark("main#main"); + if (toMark) { + mark.mark(toMark, { + accuracy: { + value: "complementary", + limiters: [",", ".", ":", "/"], + } + }); + } + + /* Search --------------------------*/ + /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */ + // Initialise search index on focus + var fuse; + $("#search-input").focus(async function(e) { + if (fuse) { + return; + } + + $(e.target).addClass("loading"); + var response = await fetch($("#search-input").data("search-index")); + var data = await response.json(); + + var options = { + keys: ["what", "text", "code"], + ignoreLocation: true, + threshold: 0.1, + includeMatches: true, + includeScore: true, + }; + fuse = new Fuse(data, options); + + $(e.target).removeClass("loading"); + }); + + // Use algolia autocomplete + var options = { + autoselect: true, + debug: true, + hint: false, + minLength: 2, + }; + var q; +async function searchFuse(query, callback) { + await fuse; + + var items; + if (!fuse) { + items = []; + } else { + q = query; + var results = fuse.search(query, { limit: 20 }); + items = results + .filter((x) => x.score <= 0.75) + .map((x) => x.item); + if (items.length === 0) { + items = [{dir:"Sorry 😿",previous_headings:"",title:"No results found.",what:"No results found.",path:window.location.href}]; + } + } + callback(items); +} + $("#search-input").autocomplete(options, [ + { + name: "content", + source: searchFuse, + templates: { + suggestion: (s) => { + if (s.title == s.what) { + return `${s.dir} >
    ${s.title}
    `; + } else if (s.previous_headings == "") { + return `${s.dir} >
    ${s.title}
    > ${s.what}`; + } else { + return `${s.dir} >
    ${s.title}
    > ${s.previous_headings} > ${s.what}`; + } + }, + }, + }, + ]).on('autocomplete:selected', function(event, s) { + window.location.href = s.path + "?q=" + q + "#" + s.id; + }); + }); })(window.jQuery || window.$) + + diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index fc862bc..60d9294 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,6 +1,12 @@ -pandoc: 1.19.2.1 -pkgdown: 1.1.0 +pandoc: 3.1.11 +pkgdown: 2.0.9 pkgdown_sha: ~ articles: - Getting_Started: ../../../../../../../c:/z/analysis/projects/martin_cox/EchoviewR/vignettes/Getting_Started.html + BroadbandST: BroadbandST.html + Getting_Started: Getting_Started.html + Introduction: Introduction.html +last_built: 2024-05-14T02:25Z +urls: + reference: http://australianantarcticdivision.github.io/EchoviewR/reference + article: http://australianantarcticdivision.github.io/EchoviewR/articles diff --git a/docs/reference/CCAMLR_SWARMR04.EV.html b/docs/reference/CCAMLR_SWARMR04.EV.html index 9a11be6..38724ae 100644 --- a/docs/reference/CCAMLR_SWARMR04.EV.html +++ b/docs/reference/CCAMLR_SWARMR04.EV.html @@ -1,162 +1,86 @@ - - - - - - - -Echoview template for krill swarms based analysis developed during the CCAMLR SG-ASAM 2017 meeting. — CCAMLR_SWARMR04.EV • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Echoview template for krill swarms based analysis developed during the CCAMLR SG-ASAM 2017 meeting. — CCAMLR_SWARMR04.EV • EchoviewR + Skip to contents + +
    -
    -
    -

    Echoview template for krill swarms based analysis developed during the CCAMLR SG-ASAM 2017 meeting.

    - Source: R/data.R - +
    +

    Echoview template for krill swarms based analysis developed during the CCAMLR SG-ASAM 2017 meeting.

    + Source: R/data.R +
    CCAMLR_SWARMR04.EV.Rd
    -
    - -

    This is an Echoview (.EV) file and can only be read in Echoview version 8 or later. See the SG-ASAM 2017 meeting report for the Echvoiew template development rationale as well as parameter settings https://www.ccamlr.org/en/sg-asam-17

    - +
    +

    This is an Echoview (.EV) file and can only be read in Echoview version 8 or later. See the SG-ASAM 2017 meeting report for the Echvoiew template development rationale as well as parameter settings https://www.ccamlr.org/en/sg-asam-17

    - -

    Details

    +
    +

    Details

    This Echoview template file is set-up for dual frequency (38 and 120 kHz) EK60 and ES60/70 data. Impulse and background noise removal algorithms are included, and it is possible to export krill areal density directly from the template.

    - -

    Note

    - -

    Echoview (R) is a registered trademark of Echoview Software Pty Ltd. Website: www.echoview.com/ and to carry out operations using this file an Echoview (R) license is required.

    - - -
    - +
    +

    Note

    +

    Echoview (R) is a registered trademark of Echoview Software Pty Ltd. Website: www.echoview.com/ and to carry out operations using this file an Echoview (R) license is required.

    +
    -
  • Note
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVAcoVarNameFinder.html b/docs/reference/EVAcoVarNameFinder.html index 5e0baad..fe5e213 100644 --- a/docs/reference/EVAcoVarNameFinder.html +++ b/docs/reference/EVAcoVarNameFinder.html @@ -1,193 +1,118 @@ - - - - - - - -Find an acoustic variable by name — EVAcoVarNameFinder • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Find an acoustic variable by name — EVAcoVarNameFinder • EchoviewR + Skip to contents + +
    -
    -
    -

    Find an acoustic variable by name

    - Source: R/EchoviewR.R - +
    +

    Find an acoustic variable by name

    + Source: R/EVAcoVarNameFinder.R +
    EVAcoVarNameFinder.Rd
    -
    - +

    This function finds an acoustic variable in an Echoview file by name and returns the variable pointer.

    -
    - 
    EVAcoVarNameFinder(EVFile, acoVarName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    acoVarName

    The name of an acoustic variable in the Echoview file

    - -

    Value

    +
    +

    Usage

    + 
    EVAcoVarNameFinder(EVFile, acoVarName)
    +
    -

    a list object with two elements. $EVVar: An Echoview acoustic variable object, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    acoVarName
    +

    The name of an acoustic variable in the Echoview file

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-varObj <- EVAcoVarNameFinder(EVFile, "120 7x7 convolution")$EVVar
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with two elements. $EVVar: An Echoview acoustic variable object, and $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+varObj <- EVAcoVarNameFinder(EVFile, "120 7x7 convolution")$EVVar
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVAddCalibrationFile.html b/docs/reference/EVAddCalibrationFile.html index 0360085..5ae092c 100644 --- a/docs/reference/EVAddCalibrationFile.html +++ b/docs/reference/EVAddCalibrationFile.html @@ -1,196 +1,120 @@ - - - - - - - -Add a calibration file (.ecs) to a fileset — EVAddCalibrationFile • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Add a calibration file (.ecs) to a fileset — EVAddCalibrationFile • EchoviewR + Skip to contents + +
    -
    -
    -

    Add a calibration file (.ecs) to a fileset

    - Source: R/EchoviewR.R - +
    +

    Add a calibration file (.ecs) to a fileset

    + Source: R/EchoviewR.R +
    EVAddCalibrationFile.Rd
    -
    - +

    This function adds a calibration file (.ecs) to a fileset using COM scripting.

    -
    - 
    EVAddCalibrationFile(EVFile, filesetName, calibrationFile)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    filesetName

    An Echoview fileset name

    calibrationFile

    An Echoview calibration (.ecs) file path and name

    - -

    Value

    +
    +

    Usage

    + 
    EVAddCalibrationFile(EVFile, filesetName, calibrationFile)
    +
    -

    a list object with one element. $msg: message for processing log

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    filesetName
    +

    An Echoview fileset name

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVAddCalibrationFile(EVFile = EVFile, filesetName = '038-120-200',
-calibrationFile = '~~/KAOS/20120326_KAOS_SimradEK5.ecs')
-# }
    -
    - +
    +

    Value

    + -
    -
    +

    a list object with one element. $msg: message for processing log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVAddCalibrationFile(EVFile = EVFile, filesetName = '038-120-200', 
+calibrationFile = '~~/KAOS/20120326_KAOS_SimradEK5.ecs')
+}
+
    +
    +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVAddRawData.html b/docs/reference/EVAddRawData.html index 29a16c8..6092f0a 100644 --- a/docs/reference/EVAddRawData.html +++ b/docs/reference/EVAddRawData.html @@ -1,197 +1,121 @@ - - - - - - - -Add raw data files to an open Echoview file (.EV) — EVAddRawData • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Add raw data files to an open Echoview file (.EV) — EVAddRawData • EchoviewR + Skip to contents + +
    -
    -
    -

    Add raw data files to an open Echoview file (.EV)

    - Source: R/EchoviewR.R - +
    +

    Add raw data files to an open Echoview file (.EV)

    + Source: R/EchoviewR.R +
    EVAddRawData.Rd
    -
    - +

    This function adds raw data files to an open Echoview file (.EV) via COM scripting. The function assumes the Echoview fileset name already exists.

    -
    - 
    EVAddRawData(EVFile, filesetName, dataFiles)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    filesetName

    Echoview fileset name

    dataFiles

    vector of full path and name for each data file.

    - -

    Value

    +
    +

    Usage

    + 
    EVAddRawData(EVFile, filesetName, dataFiles)
    +
    -

    a list object with two elements. $nbrFilesInFileset: number of raw data files in the fileset, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVNewFile EVCreateNew

    - +
    filesetName
    +

    Echoview fileset name

    -

    Examples

    - 
    # NOT RUN {
-filenamesV <- c('~~/KAOS/raw/L0055-D20030115-T171028-EK60.raw',
-                 '~~/KAOS/raw/L0055-D20030115-T182914-EK60.raw')
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVNewFile(EVAppObj,templateFn="~~/KAOS/KAOStemplate.EV")$EVFile
-EVAddRawData(EVFile = EVFile, filesetName = '038-120-200', dataFiles = filenamesV)
-# }
    -
    - +
    +

    Value

    + -
    -
    +

    a list object with two elements. $nbrFilesInFileset: number of raw data files in the fileset, and $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVNewFile EVCreateNew

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+filenamesV <- c('~~/KAOS/raw/L0055-D20030115-T171028-EK60.raw', 
+                 '~~/KAOS/raw/L0055-D20030115-T182914-EK60.raw')
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVNewFile(EVAppObj,templateFn="~~/KAOS/KAOStemplate.EV")$EVFile
+EVAddRawData(EVFile = EVFile, filesetName = '038-120-200', dataFiles = filenamesV)
+}
+
    +
    +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVAddVariable.html b/docs/reference/EVAddVariable.html index 5a8d1f6..5962491 100644 --- a/docs/reference/EVAddVariable.html +++ b/docs/reference/EVAddVariable.html @@ -1,207 +1,126 @@ - - - - - - - -Add a variable to an Echoview file — EVAddVariable • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Add a variable to an Echoview file — EVAddVariable • EchoviewR + Skip to contents + +
    -
    -
    -

    Add a variable to an Echoview file

    - Source: R/EVAddVariable.R - +
    +

    Add a variable to an Echoview file

    + Source: R/EVAddVariable.R +
    EVAddVariable.Rd
    -
    - +

    This function adds an Echoview variable to an existing Echoview file. The variable is added by specifying the existing variable to which the new variable is added and the new variable type.

    -
    - 
    EVAddVariable(EVFile, acoVarName, EOperator, addedVarName = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    Echoview file COM object

    acoVarName

    The acoustic variable name to which a new variable will be added.

    EOperator

    The 'EOperator' number of the variable to add. See notes

    addedVarName

    =NULL. Name of the added variable.

    - -

    Value

    +
    +

    Usage

    + 
    EVAddVariable(EVFile, acoVarName, EOperator, addedVarName = NULL)
    +
    -

    list with three elements: $varObj acoustic variable COM object; $objName new name of the variable object;$msg message vector

    - -

    Details

    +
    +

    Arguments

    +
    EVFile
    +

    Echoview file COM object

    -

    The new variable type is specifed using the variable-specific 'EOperator' integer. For example, the 'Ping subset' operator 'EOperator' is 62. See Echoview help for details.

    - -

    Note

    -

    This function is under development. We hope to add an 'EOperator' look up table sp that the type of variable to add can be specified by its character name, rather than 'EOperator'

    - -

    References

    +
    acoVarName
    +

    The acoustic variable name to which a new variable will be added.

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVAcoVarNameFinder

    - - -
    - +
    +

    Value

    + -
  • See also
    • - +

    list with three elements: $varObj acoustic variable COM object; $objName new name of the variable object; $msg message vector

    +
    +
    +

    Details

    +

    The new variable type is specifed using the variable-specific 'EOperator' integer. For example, the 'Ping subset' operator 'EOperator' is 62. See Echoview help for details.

    +
    +
    +

    Note

    +

    This function is under development. We hope to add an 'EOperator' look up table sp that the type of variable to add can be specified by its character name, rather than 'EOperator'

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVAcoVarNameFinder

    +
    +
    +

    Author

    +

    Martin Cox

    +
    -

    Author

    - -Martin Cox +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVAdjustDataRngBitmap.html b/docs/reference/EVAdjustDataRngBitmap.html index 0d0cd6f..736205f 100644 --- a/docs/reference/EVAdjustDataRngBitmap.html +++ b/docs/reference/EVAdjustDataRngBitmap.html @@ -1,196 +1,120 @@ - - - - - - - -Change the data range bitmap of an acoustic object — EVAdjustDataRngBitmap • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Change the data range bitmap of an acoustic object — EVAdjustDataRngBitmap • EchoviewR + Skip to contents + +
    -
    -
    -

    Change the data range bitmap of an acoustic object

    - Source: R/EchoviewR.R - +
    +

    Change the data range bitmap of an acoustic object

    + Source: R/EchoviewR.R +
    EVAdjustDataRngBitmap.Rd
    -
    - +

    This function changes the data range in an Echoview data range bitmap virtual variable

    -
    - 
    EVAdjustDataRngBitmap(varObj, minRng, maxRng)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    varObj

    An Echoview acoustic variable COM object, perhaps resulting from a call of EVAcoVarNameFinder()

    minRng

    the minimum data value to set

    maxRng

    the maximum data value to set

    - -

    Value

    +
    +

    Usage

    + 
    EVAdjustDataRngBitmap(varObj, minRng, maxRng)
    +
    -

    a vector of pre- and post-function call data range settings

    - -

    References

    +
    +

    Arguments

    +
    varObj
    +

    An Echoview acoustic variable COM object, perhaps resulting from a call of EVAcoVarNameFinder()

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile EVAcoVarNameFinder

    - +
    minRng
    +

    the minimum data value to set

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-varObj <- EVAcoVarNameFinder(EVFile, acoVarName = "38 data range bitmap")$EVVar
-EVAdjustDataRngBitmap(varObj, minRng = -90, maxRng = 0)
-# }
    -
    - +
    +

    Value

    + -
    -
    +

    a vector of pre- and post-function call data range settings

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVAcoVarNameFinder

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+varObj <- EVAcoVarNameFinder(EVFile, acoVarName = "38 data range bitmap")$EVVar
+EVAdjustDataRngBitmap(varObj, minRng = -90, maxRng = 0)
+}
+
    +
    +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVBottomDetection.html b/docs/reference/EVBottomDetection.html index ef5cb94..630f864 100644 --- a/docs/reference/EVBottomDetection.html +++ b/docs/reference/EVBottomDetection.html @@ -1,244 +1,188 @@ - - - - - - +Bottom Detection — EVBottomDetection • EchoviewR + Skip to contents + -Bottom Detection — EVBottomDetection • EchoviewR +
    +
    +
    +

    Bottom Detection

    + Source: R/EVBottomDetection.R +
    EVBottomDetection.Rd
    +
    - - - +
    +

    This function runs a bottom detection on an echogram +Bottom algorithms and settings are explained in the [Echoview Help File]('https://support.echoview.com/WebHelp/Reference/Algorithms/Line_picking_algorithm.htm')

    +
    +
    +

    Usage

    + 
    EVBottomDetection(
+  EVFile,
+  EVVar,
+  LineName = "Bottom",
+  algorithm = NULL,
+  StartDepth = NULL,
+  StopDepth = NULL,
+  MinSv = NULL,
+  UseBackstep = NULL,
+  DiscriminationLevel = NULL,
+  BackstepRange = NULL,
+  PeakThreshold = NULL,
+  MaxDropouts = NULL,
+  WindowRadius = NULL,
+  MinPeakAssymmetry = NULL,
+  replaceOldBottom = TRUE,
+  SpanGaps = TRUE
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    - - - +
    EVVar
    +

    An Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    +
    LineName
    +

    Character of the output name for the detected Line

    - - - - - - - - -
    -
    - - -
    +
    StartDepth
    +

    numeric [m] Minimum bottom detection depth

    -
    -
    -
    -

    Bottom Detection

    - Source: R/EVBottomDetection.R - -
    -
    - -

    This function runs a bottom detection on an echogram -Bottom algorithms and settings are explained in the [Echoview Help File]('https://support.echoview.com/WebHelp/Reference/Algorithms/Line_picking_algorithm.htm')

    - -
    +
    StopDepth
    +

    numeric [m] maximum bottom detection detpth

    - 
    EVBottomDetection(EVFile, EVVar, LineName = "Bottom", algorithm = NULL,
-  StartDepth = NULL, StopDepth = NULL, MinSv = NULL,
-  UseBackstep = NULL, DiscriminationLevel = NULL,
-  BackstepRange = NULL, PeakThreshold = NULL, MaxDropouts = NULL,
-  WindowRadius = NULL, MinPeakAssymmetry = NULL,
-  replaceOldBottom = TRUE, SpanGaps = TRUE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    EVVar

    An Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    LineName

    Character of the output name for the detected Line

    algorithm

    numeric [0 - 2] Defines which bottom detection algorithm should be used: 0 for Delta Sv, 1 for Maximum Sv, 2 for Best bottom Candidate

    StartDepth

    numeric [m] Minimum bottom detection depth

    StopDepth

    numeric [m] maximum bottom detection detpth

    MinSv

    numeric [dB] minimum detection Sv

    UseBackstep

    Boolean [True or False]

    DiscriminationLevel

    numeric [dB] Minimum discrimination threshold

    BackstepRange

    numeric [m] Backstep range

    PeakThreshold

    numeric [dB] Threshold for peak detection

    MinPeakAssymmetry

    numeric

    replaceOldBottom

    Boolean (TRUE or FALSE) If TRUE and a line with the same name as LineName already exists, the old line will be overwritten with the new one

    SpanGaps

    Boolean (TRUE or FALSE) Decides wheteher span gaps is activated or notm default=TRUE

    MaxDropOuts

    numeric [samples] Maximum number of dropout samples before bottom detection fails

    windowRadius

    numeric [samples] Search window size

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - +
    MinSv
    +

    numeric [dB] minimum detection Sv

    -

    Examples

    - 
    #To be added - Needs Example data
-#Starting Echoview
-echoview = StartEchoview()
    #> 2018-11-01 10:54:27: Opening Echoview
    #> Warning: Couldn't get clsid from the string
    #> Error: Invalid class string
    #Create a new EV File
-EVFile <- EVCreateNew(EVAppObj=echoview, dataFiles = "rawfile.raw")$EVFile
    #> 2018-11-01 10:54:27 : Creating new EV file
    #> Error in EVNewFile(EVAppObj = EVAppObj, templateFn = templateFn): object 'echoview' not found
    Varname <- "Fileset 1: Sv pulse compressed wideband pings T1"
-bottom <- EVBottomDetection(EVFile, EVVar=Varname, LineName="Bottom")
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
    # Change the algorithm to Best bottom candidate
-bottom <- EVBottomDetection(EVFile, EVVar=Varname, LineName="Bottom",algorithm=2)
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
    
-
    -
    - -
    +
    UseBackstep
    +

    Boolean [True or False]

    + + +
    DiscriminationLevel
    +

    numeric [dB] Minimum discrimination threshold

    + + +
    BackstepRange
    +

    numeric [m] Backstep range

    + + +
    PeakThreshold
    +

    numeric [dB] Threshold for peak detection

    -
    -
    + +
    MaxDropouts
    +

    numeric [samples] Maximum number of dropout samples before bottom detection fails

    + + +
    WindowRadius
    +

    numeric [samples] Search window size

    + + +
    MinPeakAssymmetry
    +

    numeric

    + + +
    replaceOldBottom
    +

    Boolean (TRUE or FALSE) If TRUE and a line with the same name as LineName already exists, the old line will be overwritten with the new one

    + + +
    SpanGaps
    +

    Boolean (TRUE or FALSE) Decides wheteher span gaps is activated or notm default=TRUE

    + +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+#To be added - Needs Example data
+#Starting Echoview
+echoview = StartEchoview()
+#Create a new EV File
+EVFile <- EVCreateNew(EVAppObj=echoview, dataFiles = "rawfile.raw")$EVFile
+Varname <- "Fileset 1: Sv pulse compressed wideband pings T1"
+bottom <- EVBottomDetection(EVFile, EVVar=Varname, LineName="Bottom")
+# Change the algorithm to Best bottom candidate
+bottom <- EVBottomDetection(EVFile, EVVar=Varname, LineName="Bottom",algorithm=2)
+}
+
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVChangeVariableGrid.html b/docs/reference/EVChangeVariableGrid.html index 13e5a13..fd1a594 100644 --- a/docs/reference/EVChangeVariableGrid.html +++ b/docs/reference/EVChangeVariableGrid.html @@ -1,244 +1,208 @@ - - - - - - +Adjust the Echoview virtual variable 'Background noise removal' using COM — EVChangeVariableGrid • EchoviewR + Skip to contents + -Change the integration grid size and type of an Echoview acoustic variable — EVChangeVariableGrid • EchoviewR +
    +
    +
    +

    Adjust the Echoview virtual variable 'Background noise removal' using COM

    + Source: R/EVBackgroundNoiseRemoval.R, R/EVChangeVariableGrid.R +
    EVChangeVariableGrid.Rd
    +
    - - - +
    +

    This function adjusts the settings of a Background Noise Removal virtual variable using COM scripting.

    +

    This function sets the grid separation and depth reference line for an acoustic variable using COM scripting.

    +
    +
    +

    Usage

    + 
    EVChangeVariableGrid(
+  EVFile,
+  acoVarName,
+  timeDistanceGridType = NULL,
+  depthGridType = NULL,
+  timeDistanceGridDistance = NULL,
+  depthGridDistance = NULL,
+  EVLineName = NULL,
+  showenum = FALSE
+)
+
+EVChangeVariableGrid(
+  EVFile,
+  acoVarName,
+  timeDistanceGridType = NULL,
+  depthGridType = NULL,
+  timeDistanceGridDistance = NULL,
+  depthGridDistance = NULL,
+  EVLineName = NULL,
+  showenum = FALSE
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    - - - +
    acoVarName
    +

    (character) Echoview acoustic variable name

    +
    timeDistanceGridType
    +

    (numeric) specifying the along track grid type. 0 = no grid, 1 = time (minutes), 2 = GPS distance (NMi), 3 = Vessel Log Distance (NMi), 4 = Pings, 5 = GPS distance (m), 6 = Vessel Log Distance (m).

    - - - - - - - - -
    -
    - - -
    +
    timeDistanceGridDistance
    +

    (numeric) vertical grid line spacing. Not needed if verticalType = 0.

    -
    -
    -
    -

    Change the integration grid size and type of an Echoview acoustic variable

    - Source: R/EVChangeVariableGrid.R - -
    -
    - -

    This function sets the grid separation and depth reference line for an acoustic variable using COM scripting.

    - -
    +
    depthGridDistance
    +

    (numeric) horizontal grid line spacing. Ignored if horizontalType = 0.

    - 
    EVChangeVariableGrid(EVFile, acoVarName, timeDistanceGridType = NULL,
-  depthGridType = NULL, timeDistanceGridDistance = NULL,
-  depthGridDistance = NULL, EVLineName = NULL, showenum = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    acoVarName

    (character) Echoview acoustic variable name

    timeDistanceGridType

    (numeric) specifying the along track grid type. 0 = no grid, 1 = time (minutes), 2 = GPS distance (NMi), 3 = Vessel Log Distance (NMi), 4 = Pings, 5 = GPS distance (m), 6 = Vessel Log Distance (m).

    depthGridType

    (numeric) 0 = no grid, 1 = depth grid, 2 = use reference line.

    timeDistanceGridDistance

    (numeric) vertical grid line spacing. Not needed if verticalType = 0.

    depthGridDistance

    (numeric) horizontal grid line spacing. Ignored if horizontalType = 0.

    EVLineName

    (character) an Echoview line object name. Not needed if depthGridType != 2.

    showenum

    = FALSE (boolean) if TRUE Echoview grid enum values are returned to the workspace. All other arguments are ignored.

    - -

    Value

    -

    a list object with three elements. $predataRangeSettings: a vector of pre-function call settings; $postDataRangeSettings a vector of post-function call settings, and $msg: message for processing log.

    - -

    Details

    +
    EVLineName
    +

    (character) an Echoview line object name. Not needed if depthGridType != 2.

    -

    depthGridType is specified in the Echoview COM enum values called 'EDepthRangeGridMode'. TimeDistanceGridMode is specified in the Echoview COM enum values called ETimeDistanceGridMode

    - -

    Note

    -

    This function was completely rewritten Sept. 2017 which resulted in changes to function argument names.

    - -

    References

    +
    showenum
    +

    = FALSE (boolean) if TRUE Echoview grid enum values are returned to the workspace. All other arguments are ignored.

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    Value

    -

    See also

    - -

    EVAcoVarNameFinder EVFindLineByName

    - - -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-
-EVChangeVariableGrid <- function (EVFile,
-acoVarName="38 seabed and surface excluded",
-timeDistanceGridType=5, depthGridType=2,
-timeDistanceGridDistance = 100, depthGridDistance = 10,
-EVLineName = "Fixed depth 250 m")
-#remove grid:
-EVChangeVariableGrid <- function (EVFile,
-acoVarName="38 seabed and surface excluded",
-timeDistanceGridType=0, depthGridType=0)
-#only show Echoview grid enum values
-EVChangeVariableGrid(showenum = TRUE)
-# }
    -
    - +
    +

    Details

    +

    depthGridType is specified in the Echoview COM enum values called 'EDepthRangeGridMode'. TimeDistanceGridMode is specified in the Echoview COM enum values called ETimeDistanceGridMode

    +

    depthGridType is specified in the Echoview COM enum values called 'EDepthRangeGridMode'. TimeDistanceGridMode is specified in the Echoview COM enum values called ETimeDistanceGridMode

    +
    +
    +

    Note

    +

    This function was completely rewritten Sept. 2017 which resulted in changes to function argument names.

    +

    This function was completely rewritten Sept. 2017 which resulted in changes to function argument names.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVAcoVarNameFinder EVFindLineByName

    +

    EVAcoVarNameFinder EVFindLineByName

    +
    +
    +

    Author

    +

    Martin Cox

    +
    -

    Author

    - -Martin Cox +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- start
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+EVChangeVariableGrid <- function (EVFile, 
+acoVarName="38 seabed and surface excluded", 
+timeDistanceGridType=5, depthGridType=2, 
+timeDistanceGridDistance = 100, depthGridDistance = 10, 
+EVLineName = "Fixed depth 250 m")
+#remove grid:
+EVChangeVariableGrid <- function (EVFile, 
+acoVarName="38 seabed and surface excluded", 
+timeDistanceGridType=0, depthGridType=0)
+#only show Echoview grid enum values
+EVChangeVariableGrid(showenum = TRUE)
+}
+if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+EVChangeVariableGrid <- function (EVFile, 
+acoVarName="38 seabed and surface excluded", 
+timeDistanceGridType=5, depthGridType=2, 
+timeDistanceGridDistance = 100, depthGridDistance = 10, 
+EVLineName = "Fixed depth 250 m")
+#remove grid:
+EVChangeVariableGrid <- function (EVFile, 
+acoVarName="38 seabed and surface excluded", 
+timeDistanceGridType=0, depthGridType=0)
+#only show Echoview grid enum values
+EVChangeVariableGrid(showenum = TRUE)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVClearRawData.html b/docs/reference/EVClearRawData.html index 8cfa596..f219b1e 100644 --- a/docs/reference/EVClearRawData.html +++ b/docs/reference/EVClearRawData.html @@ -1,191 +1,115 @@ - - - - - - - -Clear all files from a fileset — EVClearRawData • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Clear all files from a fileset — EVClearRawData • EchoviewR + Skip to contents + +
    -
    -
    -

    Clear all files from a fileset

    - Source: R/EchoviewR.R - +
    +

    Clear all files from a fileset

    + Source: R/EchoviewR.R +
    EVClearRawData.Rd
    -
    - +

    This function clears all .raw files from a fileset using COM scripting

    -
    - 
    EVClearRawData(EVFile, filesetName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    filesetName

    An Echoview fileset name

    - -

    Value

    +
    +

    Usage

    + 
    EVClearRawData(EVFile, filesetName)
    +
    -

    A list object with one element. $msg message for processing log

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    filesetName
    +

    An Echoview fileset name

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVClearRawData(EVFile = EVFile, filesetName = '038-120-200')
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    A list object with one element. $msg message for processing log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVClearRawData(EVFile = EVFile, filesetName = '038-120-200')
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVCloseFile.html b/docs/reference/EVCloseFile.html index edf38a9..4779baa 100644 --- a/docs/reference/EVCloseFile.html +++ b/docs/reference/EVCloseFile.html @@ -1,187 +1,111 @@ - - - - - - - -Close an open Echoview file (.EV) — EVCloseFile • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Close an open Echoview file (.EV) — EVCloseFile • EchoviewR + Skip to contents + +
    -
    -
    -

    Close an open Echoview file (.EV)

    - Source: R/EchoviewR.R - +
    +

    Close an open Echoview file (.EV)

    + Source: R/EchoviewR.R +
    EVCloseFile.Rd
    -
    - +

    This function closes an open Echoview file (.EV) via COM scripting

    -
    - 
    EVCloseFile(EVFile)
    - -

    Arguments

    - - - - - - -
    EVFile

    An Echoview file COM object

    - -

    Value

    - -

    a list object with two elements. $chk: Boolean check indicating if the file was successfully closed; $msg: message for processing log.

    - -

    References

    +
    +

    Usage

    + 
    EVCloseFile(EVFile)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm

    - -

    See also

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    EVOpenFile

    +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVCloseFile(EVFile)
-# }
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVCloseFile(EVFile)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVCreateEditableLine.html b/docs/reference/EVCreateEditableLine.html index d1a9ccd..9687394 100644 --- a/docs/reference/EVCreateEditableLine.html +++ b/docs/reference/EVCreateEditableLine.html @@ -1,211 +1,141 @@ - - - - - - - -Create an EV Editable Line from an existing line — EVCreateEditableLine • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Create an EV Editable Line from an existing line — EVCreateEditableLine • EchoviewR + Skip to contents + +
    -
    -
    -

    Create an EV Editable Line from an existing line

    - Source: R/EVCreateEditableLine.R - +
    +

    Create an EV Editable Line from an existing line

    + Source: R/EVCreateEditableLine.R +
    EVCreateEditableLine.Rd
    -
    - +

    This function creates an EV Line in an EV file object by name using COM scripting.

    -
    - 
    EVCreateEditableLine(EVFile, lineNameToCopy, editableLineName = NULL,
-  Multiply = 1, Add = 0, SpanGaps = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    lineNameToCopy

    a string containing the name of the line to copy

    editableLineName

    =NULL desired editable line name.If null, EDIT is appended to lineNameToCopy and used as editable line name.

    Multiply

    =1 multiply source line depth when creating new editable line

    Add

    =0 add to source line depth when creating new editable line

    SpanGaps

    =FALSE span gaps when creating new editable line

    - -

    Value

    +
    +

    Usage

    + 
    EVCreateEditableLine(
+  EVFile,
+  lineNameToCopy,
+  editableLineName = NULL,
+  Multiply = 1,
+  Add = 0,
+  SpanGaps = FALSE
+)
    +
    -

    an Echoview editable line object

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVFindLineByName EVOpenFile

    - +
    lineNameToCopy
    +

    a string containing the name of the line to copy

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj, '~~KAOS/KAOStemplate.EV')$EVFile
 
-EVCreateEditableLine(EVFile = EVFile,
-    lineNameToCopy='Offset seabed',
-    editableLineName='Editable Seabed line')
-# }
    -
    - -
    -
    -
    +
    Add
    +

    =0 add to source line depth when creating new editable line

    + + +
    SpanGaps
    +

    =FALSE span gaps when creating new editable line

    + +
    +
    +

    Value

    + + +

    an Echoview editable line object

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVFindLineByName EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj, '~~KAOS/KAOStemplate.EV')$EVFile
+
+EVCreateEditableLine(EVFile = EVFile, 
+    lineNameToCopy='Offset seabed',
+    editableLineName='Editable Seabed line')
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVCreateFileset.html b/docs/reference/EVCreateFileset.html index 71d795d..54861e0 100644 --- a/docs/reference/EVCreateFileset.html +++ b/docs/reference/EVCreateFileset.html @@ -1,191 +1,115 @@ - - - - - - - -Create a new Echoview fileset — EVCreateFileset • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Create a new Echoview fileset — EVCreateFileset • EchoviewR + Skip to contents + +
    -
    -
    -

    Create a new Echoview fileset

    - Source: R/EchoviewR.R - +
    +

    Create a new Echoview fileset

    + Source: R/EchoviewR.R +
    EVCreateFileset.Rd
    -
    - +

    This function creates a new echoview fileset via COM scripting

    -
    - 
    EVCreateFileset(EVFile, filesetName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    filesetName

    Echoview fileset name to create

    - -

    Value

    +
    +

    Usage

    + 
    EVCreateFileset(EVFile, filesetName)
    +
    -

    a list object with two elements. $fileset: created fileset COM object, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVNewFile EVCreateNew EVOpenFile

    - +
    filesetName
    +

    Echoview fileset name to create

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVCreateFileset(EVFile = EVFile, filesetName = 'example')
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with two elements. $fileset: created fileset COM object, and $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVNewFile EVCreateNew EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVCreateFileset(EVFile = EVFile, filesetName = 'example')
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVCreateNew.html b/docs/reference/EVCreateNew.html index 3e58f4c..83b03d0 100644 --- a/docs/reference/EVCreateNew.html +++ b/docs/reference/EVCreateNew.html @@ -1,222 +1,150 @@ - - - - - - - -Create a new Echoview (.EV) file and adds raw data files to it — EVCreateNew • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Create a new Echoview (.EV) file and adds raw data files to it — EVCreateNew • EchoviewR + Skip to contents + +
    -
    -
    -

    Create a new Echoview (.EV) file and adds raw data files to it

    - Source: R/EchoviewR.R - +
    +

    Create a new Echoview (.EV) file and adds raw data files to it

    + Source: R/EchoviewR.R +
    EVCreateNew.Rd
    -
    - +

    This function creates a new Echoview (.EV) file and adds raw data files to it via COM scripting. Works well when populating an existing Echoview template file with raw data files. The newly created Echoview file will remain open in Echoview and can be accessed via the $EVFile objected returned by a successful call of this function.

    -
    - 
    EVCreateNew(EVAppObj, templateFn = NULL, EVFileName, filesetName,
-  dataFiles, CloseOnSave = TRUE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVAppObj

    An EV application COM object arising from the call COMCreate('EchoviewCom.EvApplication')

    templateFn

    = NULL Full path and filename of template file if used.

    EVFileName

    Full path and filename of Echoview (.EV) file to be created.

    filesetName

    Echoview fileset name

    dataFiles

    vector of full path and name for each data file.

    CloseOnSave

    = TRUE close the EV file in EVFileName once saved.

    - -

    Value

    +
    +

    Usage

    + 
    EVCreateNew(
+  EVAppObj,
+  templateFn = NULL,
+  EVFileName = NULL,
+  filesetName = "Fileset1",
+  dataFiles = NULL,
+  CloseOnSave = FALSE
+)
    +
    -

    a list object with two elements. $EVFile: EVFile COM object for the newly created Echoview file, and $msg: message for processing log.

    - -

    Details

    +
    +

    Arguments

    +
    EVAppObj
    +

    An EV application COM object arising from the call COMCreate('EchoviewCom.EvApplication')

    -

    For the example code to run, the example data must be downloaded from. NB the example code assumes the data and directory structure of the example data has been maintained.

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    templateFn
    +

    = NULL Full path and filename of template file if used.

    -

    EVNewFile EVAddRawData EVCloseFile

    - -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-pathAndFn=list.files("~~/KAOS/raw/", full.names=TRUE)
-#remove any evi type files
-eviLoc=grep('.evi',pathAndFn)
-if(length(eviLoc)>0) (pathAndFn=pathAndFn[-eviLoc])
-EVCreateNew(EVAppObj=EVAppObj,
-                 templateFn="~~/KAOS/KAOStemplate.EV",
-                 EVFileName='~~/KAOS/kaos.ev',
-                 filesetName="038-120-200",
-                 dataFiles=pathAndFn,
-                 CloseOnSave = TRUE)
-# }
    -
    - -
    +
    dataFiles
    +

    vector of full path and name for each data file.

    + -
    -
    +
    CloseOnSave
    +

    = TRUE close the EV file in EVFileName once saved.

    + +
    +
    +

    Value

    + + +

    a list object with two elements. $EVFile: EVFile COM object for the newly created Echoview file, and $msg: message for processing log.

    +
    +
    +

    Details

    +

    For the example code to run, the example data must be downloaded from. NB the example code assumes the data and directory structure of the example data has been maintained.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVNewFile EVAddRawData EVCloseFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+pathAndFn=list.files("~~/KAOS/raw/", full.names=TRUE)
+#remove any evi type files
+eviLoc=grep('.evi',pathAndFn)
+if(length(eviLoc)>0) (pathAndFn=pathAndFn[-eviLoc])
+EVCreateNew(EVAppObj=EVAppObj,
+                 templateFn="~~/KAOS/KAOStemplate.EV",
+                 EVFileName='~~/KAOS/kaos.ev',
+                 filesetName="038-120-200",
+                 dataFiles=pathAndFn, 
+                 CloseOnSave = TRUE)
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVDeleteLine.html b/docs/reference/EVDeleteLine.html index e9c8804..d1a9d20 100644 --- a/docs/reference/EVDeleteLine.html +++ b/docs/reference/EVDeleteLine.html @@ -1,193 +1,117 @@ - - - - - - - -Deletes an Echoview line object — EVDeleteLine • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Deletes an Echoview line object — EVDeleteLine • EchoviewR + Skip to contents + +
    -
    -
    -

    Deletes an Echoview line object

    - Source: R/EchoviewR.R - +
    +

    Deletes an Echoview line object

    + Source: R/EchoviewR.R +
    EVDeleteLine.Rd
    -
    - +

    This function deletes an Echoview line object using COM scripting

    -
    - 
    EVDeleteLine(EVFile, evLine)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    evLine

    an Echoview line object

    - -

    Value

    - -

    a list object with one element- function message for log

    - -

    References

    +
    +

    Usage

    + 
    EVDeleteLine(EVFile, evLine)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    EVOpenFile EVNewFixedDepthLine EVFindLineByName

    - -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
    evLine
    
+
    an Echoview line object
    
 
-testline <- EVNewFixedDepthLine(EVFile = EVFile, depth = 50, lineName = "test_line")
-EVDeleteLine(EVFile = EVFile, evLine = testline)
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with one element- function message for log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVNewFixedDepthLine EVFindLineByName

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+testline <- EVNewFixedDepthLine(EVFile = EVFile, depth = 50, lineName = "test_line")
+EVDeleteLine(EVFile = EVFile, evLine = testline)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVDeleteRegionClass.html b/docs/reference/EVDeleteRegionClass.html index aad3089..22e8ba9 100644 --- a/docs/reference/EVDeleteRegionClass.html +++ b/docs/reference/EVDeleteRegionClass.html @@ -1,192 +1,116 @@ - - - - - - - -Delete an Echoview region class — EVDeleteRegionClass • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Delete an Echoview region class — EVDeleteRegionClass • EchoviewR + Skip to contents + +
    -
    -
    -

    Delete an Echoview region class

    - Source: R/EchoviewR.R - +
    +

    Delete an Echoview region class

    + Source: R/EchoviewR.R +
    EVDeleteRegionClass.Rd
    -
    - +

    This function deletes a region class within an Echoview object using COM scripting.

    -
    - 
    EVDeleteRegionClass(EVFile, regionClassCOMObj)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    regionClassCOMObj

    An Echoview region object

    - -

    Value

    +
    +

    Usage

    + 
    EVDeleteRegionClass(EVFile, regionClassCOMObj)
    +
    -

    a list object with two elements. $EVVar: An Echoview acoustic variable object, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile EVRegionClassFinder

    - +
    regionClassCOMObj
    +

    An Echoview region object

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-exampleClass <- EVRegionClassFinder(EVFile, "003")$regionClass
-EVDeleteRegionClass(EVFile, exampleClass)
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with two elements. $EVVar: An Echoview acoustic variable object, and $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVRegionClassFinder

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+exampleClass <- EVRegionClassFinder(EVFile, "003")$regionClass
+EVDeleteRegionClass(EVFile, exampleClass)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportEchogramToImage.html b/docs/reference/EVExportEchogramToImage.html index 0c54ba4..0f1b606 100644 --- a/docs/reference/EVExportEchogramToImage.html +++ b/docs/reference/EVExportEchogramToImage.html @@ -1,190 +1,120 @@ - - - - - - +Export an Echoview acoustic variable to an image file — EVExportEchogramToImage • EchoviewR + Skip to contents + -Export an Echoview acoustic variable to an image file — EVExportEchogramToImage • EchoviewR +
    +
    +
    +

    Export an Echoview acoustic variable to an image file

    + Source: R/EVExportEchogramToImage.R +
    EVExportEchogramToImage.Rd
    +
    - - - +
    +

    This function exports an Echoview acoustic variable to an image file.

    +
    +
    +

    Usage

    + 
    EVExportEchogramToImage(
+  EVFile,
+  acoVarName,
+  filePath,
+  heightInPixels,
+  pingRange = c(-1, -1)
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    Echoview file COM object

    - - - +
    acoVarName
    +

    The acoustic variable name to export

    +
    filePath
    +

    Path and filename for the resulting image file. The image type is controlled here by specifying the desired extension, e.g. *.jpg

    - - - - - - - - -
    -
    - - -
    +
    pingRange
    +

    =c(-1,1) Optional ping range over which to export the Echoview line object. Default is to export the lien for all pings

    -
    -
    -
    -

    Export an Echoview acoustic variable to an image file

    - Source: R/EVExportEchogramToImage.R - -
    - -
    - -

    This function exports an Echoview acoustic variable to an image file.

    +
    +
    +

    Value

    -
    - - 
    EVExportEchogramToImage(EVFile, acoVarName, filePath, heightInPixels,
-  pingRange = c(-1, -1))
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    Echoview file COM object

    acoVarName

    The acoustic variable name to export

    filePath

    Path and filename for the resulting image file. The image type is controlled here by specifying the desired extension, e.g. *.jpg

    heightInPixels

    Vertical resolution of exported image in pixels. NB Echoview requires a 25 pixel minimum vertical resolution

    pingRange

    =c(-1,1) Optional ping range over which to export the Echoview line object. Default is to export the lien for all pings

    - -

    Value

    - -

    List of length two [1] Boolean flag indicating success or failure of export, and [1] message vector

    - -

    Details

    +

    List of length two [1] Boolean flag indicating success or failure of export, and [1] message vector

    +
    +
    +

    Details

    The following image types are available: *.bmp, *.jpg, *.jpeg, *.png, *.tif, *.tiff.

    - - -
    - -
  • Details
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportIntegrationAllRegions.html b/docs/reference/EVExportIntegrationAllRegions.html index ae0f656..8f4168a 100644 --- a/docs/reference/EVExportIntegrationAllRegions.html +++ b/docs/reference/EVExportIntegrationAllRegions.html @@ -1,185 +1,110 @@ - - - - - - - -Export echo integration from Echoview for all regions in an Echoview acoustic variable — EVExportIntegrationAllRegions • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Export echo integration from Echoview for all regions in an Echoview acoustic variable — EVExportIntegrationAllRegions • EchoviewR + Skip to contents + +
    -
    -
    -

    Export echo integration from Echoview for all regions in an Echoview acoustic variable

    - Source: R/EVExportIntegrationAllRegions.R - +
    +

    Export echo integration from Echoview for all regions in an Echoview acoustic variable

    + Source: R/EVExportIntegrationAllRegions.R +
    EVExportIntegrationAllRegions.Rd
    -
    - +

    This function integrates all acoustic data within all regions for an Echoview acoustic variable. The data can either be exported on a grid or as one integration per region.

    -
    - 
    EVExportIntegrationAllRegions(EVFile, acoVarName, grid = FALSE, exportFn)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    ("COMIDispatch) An Echoview file COM object

    acoVarName

    (string) Echoview acoustic variable name

    grid

    = FALSE (boolean) Integrate all data within a region to the region extents or when TRUE integrate on to a grid within the Echoview acoustic variable

    exportFn

    CSV export file path and file name.

    - -

    Value

    +
    +

    Usage

    + 
    EVExportIntegrationAllRegions(EVFile, acoVarName, grid = FALSE, exportFn)
    +
    + +
    +

    Arguments

    +
    EVFile
    +

    ("COMIDispatch) An Echoview file COM object

    -

    list $msg messages resulting from function call

    - -

    See also

    -

    EVChangeVariableGrid

    +
    acoVarName
    +

    (string) Echoview acoustic variable name

    + + +
    grid
    +

    = FALSE (boolean) Integrate all data within a region to the region extents or when TRUE integrate on to a grid within the Echoview acoustic variable

    + + +
    exportFn
    +

    CSV export file path and file name.

    + +
    +
    +

    Value

    -
    - +
    +

    See also

    +

    EVChangeVariableGrid

    +
    -
  • See also
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportIntegrationByCells.html b/docs/reference/EVExportIntegrationByCells.html index 3ccffa0..da8ee32 100644 --- a/docs/reference/EVExportIntegrationByCells.html +++ b/docs/reference/EVExportIntegrationByCells.html @@ -1,197 +1,121 @@ - - - - - - - -Export integration by cells for an acoustic variable — EVExportIntegrationByCells • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Export integration by cells for an acoustic variable — EVExportIntegrationByCells • EchoviewR + Skip to contents + +
    -
    -
    -

    Export integration by cells for an acoustic variable

    - Source: R/EchoviewR.R - +
    +

    Export integration by cells for an acoustic variable

    + Source: R/EchoviewR.R +
    EVExportIntegrationByCells.Rd
    -
    - +

    This function exports the integration by cells for an acoustic variable using COM scripting. Note: This function will only work if the acoustic variable has a grid.

    -
    - 
    EVExportIntegrationByCells(EVFile, variableName, filePath)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    variableName

    a string containing the name of an EV acoustic variable

    filePath

    a string containing the file path and name to save the exported data to

    - -

    Value

    +
    +

    Usage

    + 
    EVExportIntegrationByCells(EVFile, variableName, filePath)
    +
    -

    a list object with 1 element: message for progessing log

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    variableName
    +

    a string containing the name of an EV acoustic variable

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVExportIntegrationByCells(EVFile = EVFile,
-variableName = '38 seabed and surface excluded',
-filePath = '~~/KAOS/EVExportIntegrationByCells_example.csv')
-# }
    -
    - +
    +

    Value

    + -
    -
    +

    a list object with 1 element: message for progessing log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVExportIntegrationByCells(EVFile = EVFile, 
+variableName = '38 seabed and surface excluded', 
+filePath = '~~/KAOS/EVExportIntegrationByCells_example.csv')
+}
+
    +
    +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportIntegrationByRegionByCells.html b/docs/reference/EVExportIntegrationByRegionByCells.html index 76e920e..58fb99d 100644 --- a/docs/reference/EVExportIntegrationByRegionByCells.html +++ b/docs/reference/EVExportIntegrationByRegionByCells.html @@ -1,196 +1,119 @@ - - - - - - - -Export integration by region name by cells for an acoustic variable — EVExportIntegrationByRegionByCells • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Export integration by region name by cells for an acoustic variable — EVExportIntegrationByRegionByCells • EchoviewR + Skip to contents + +
    -
    -
    -

    Export integration by region name by cells for an acoustic variable

    - Source: R/EchoviewR.R - +
    +

    Export integration by region name by cells for an acoustic variable

    + Source: R/EchoviewR.R +
    EVExportIntegrationByRegionByCells.Rd
    -
    - +

    This function exports the integration by region by cells for an acoustic variable using COM scripting. Unlike EVIntegrationByRegionsByCellsExport, this function exports integration data for only for a single region name, not a region class. Note: This function will only work if the acoustic variable has a grid.

    -
    - 
    EVExportIntegrationByRegionByCells(EVFile, variableName, regionName,
-  filePath)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    variableName

    a string containing the name of an EV acoustic variable

    regionName

    a string containing the name of the region to export. Note: Input a single region's name, not region a class. To export by class, see EVIntegrationByRegionsByCellsExport.

    filePath

    a string containing the file path and name to save the exported data to

    - -

    References

    +
    +

    Usage

    + 
    EVExportIntegrationByRegionByCells(EVFile, variableName, regionName, filePath)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    EVOpenFile

    - -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVExportIntegrationByRegionByCells(EVFile = EVFile,
-variableName = '38 seabed and surface excluded', 'Region1',
-filePath = '~~/KAOS/EVExportIntegrationByRegionByCells_example.csv')
-# }
    -
    - -
    -
    -
    +
    regionName
    +

    a string containing the name of the region to export. Note: Input a single region's name, not region a class. To export by class, see EVIntegrationByRegionsByCellsExport.

    + + +
    filePath
    +

    a string containing the file path and name to save the exported data to

    + +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVExportIntegrationByRegionByCells(EVFile = EVFile, 
+variableName = '38 seabed and surface excluded', 'Region1', 
+filePath = '~~/KAOS/EVExportIntegrationByRegionByCells_example.csv')
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportLineAsCSV.html b/docs/reference/EVExportLineAsCSV.html index 01fea69..9c4d520 100644 --- a/docs/reference/EVExportLineAsCSV.html +++ b/docs/reference/EVExportLineAsCSV.html @@ -1,184 +1,114 @@ - - - - - - +Export an Echoview line as a CSV file — EVExportLineAsCSV • EchoviewR + Skip to contents + -Export an Echoview line as a CSV file — EVExportLineAsCSV • EchoviewR +
    +
    +
    +

    Export an Echoview line as a CSV file

    + Source: R/EVExportLine.R +
    EVExportLineAsCSV.Rd
    +
    - - - +
    +

    This function exports an Echoview line object as a CSV file.

    +
    +
    +

    Usage

    + 
    EVExportLineAsCSV(
+  EVFile,
+  acoVarName,
+  lineName,
+  filePath,
+  pingRange = c(-1, -1)
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    Echoview file COM object

    - - - +
    acoVarName
    +

    The acoustic variable name to which the line is associated

    +
    lineName
    +

    Echoview line object name

    - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    Export an Echoview line as a CSV file

    - Source: R/EVExportLine.R - -
    - -
    - -

    This function exports an Echoview line object as a CSV file.

    - -
    - 
    EVExportLineAsCSV(EVFile, acoVarName, lineName, filePath,
-  pingRange = c(-1, -1))
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    Echoview file COM object

    acoVarName

    The acoustic variable name to which the line is associated

    lineName

    Echoview line object name

    filePath

    Path and filename for the resulting CSV file.

    pingRange

    =c(-1,1) Optional ping range over which to export the Echoview line object. Default is to export the lien for all pings

    - -

    Details

    +
    pingRange
    +

    =c(-1,1) Optional ping range over which to export the Echoview line object. Default is to export the lien for all pings

    +
    +
    +

    Details

    The Echoview line object should be associated with an Echoview acoustic variable object. Optionally, the line can be exported for a subset of pings.

    - +
    -
    - -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportRegionDef.html b/docs/reference/EVExportRegionDef.html index b38e968..4fc70c5 100644 --- a/docs/reference/EVExportRegionDef.html +++ b/docs/reference/EVExportRegionDef.html @@ -1,196 +1,120 @@ - - - - - - - -Exports an Echoview region definition — EVExportRegionDef • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Exports an Echoview region definition — EVExportRegionDef • EchoviewR + Skip to contents + +
    -
    -
    -

    Exports an Echoview region definition

    - Source: R/EchoviewR.R - +
    +

    Exports an Echoview region definition

    + Source: R/EchoviewR.R +
    EVExportRegionDef.Rd
    -
    - +

    This function exports a single region's definition as a .csv file using COM scripting

    -
    - 
    EVExportRegionDef(EVFile, regionName, filePath)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    regionName

    a string containing the region name to export definitions for

    filePath

    a string containing the name and file path of the file to export to

    - -

    Value

    +
    +

    Usage

    + 
    EVExportRegionDef(EVFile, regionName, filePath)
    +
    -

    a list object with one element- fucntion message for log

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    regionName
    +

    a string containing the region name to export definitions for

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
 
-EVExportRegionDef(EVFile, regionName = "Region1", filePath = "~~/KAOS/EVExportRegionDef.csv")
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with one element- fucntion message for log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+EVExportRegionDef(EVFile, regionName = "Region1", filePath = "~~/KAOS/EVExportRegionDef.csv")
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportRegionDefByClass.html b/docs/reference/EVExportRegionDefByClass.html index 32d6df3..5ded670 100644 --- a/docs/reference/EVExportRegionDefByClass.html +++ b/docs/reference/EVExportRegionDefByClass.html @@ -1,193 +1,117 @@ - - - - - - - -Exports definitions for all Echoview regions in a region class — EVExportRegionDefByClass • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Exports definitions for all Echoview regions in a region class — EVExportRegionDefByClass • EchoviewR + Skip to contents + +
    -
    -
    -

    Exports definitions for all Echoview regions in a region class

    - Source: R/EchoviewR.R - +
    +

    Exports definitions for all Echoview regions in a region class

    + Source: R/EchoviewR.R +
    EVExportRegionDefByClass.Rd
    -
    - +

    This function exports definitions for all Echoview regions within a region class using COM scripting

    -
    - 
    EVExportRegionDefByClass(evRegionClass, filePath)
    - -

    Arguments

    - - - - - - - - - - -
    evRegionClass

    an Echoview region class object

    filePath

    a string containing the name and file path of the file to export to

    - -

    Value

    - -

    a list object with one element- fucntion message for log

    - -

    References

    +
    +

    Usage

    + 
    EVExportRegionDefByClass(evRegionClass, filePath)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    +

    Arguments

    +
    evRegionClass
    +

    an Echoview region class object

    -

    EVOpenFile EVRegionClassFinder

    - -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
    filePath
    
+
    a string containing the name and file path of the file to export to
    
 
-regionClass <- EVRegionClassFinder(EVFile, "aggregations")$regionClass
-EVExportRegionDefByClass(evRegionClass = regionClass, filePath = "~~/KAOS/EVExportRegionDefByClass_example.csv")
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with one element- fucntion message for log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVRegionClassFinder

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+regionClass <- EVRegionClassFinder(EVFile, "aggregations")$regionClass
+EVExportRegionDefByClass(evRegionClass = regionClass, filePath = "~~/KAOS/EVExportRegionDefByClass_example.csv")
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportRegionSv.html b/docs/reference/EVExportRegionSv.html index 37cb453..c8ef844 100644 --- a/docs/reference/EVExportRegionSv.html +++ b/docs/reference/EVExportRegionSv.html @@ -1,200 +1,124 @@ - - - - - - - -Export Sv data for an Echoview acoustic variable by region — EVExportRegionSv • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Export Sv data for an Echoview acoustic variable by region — EVExportRegionSv • EchoviewR + Skip to contents + +
    -
    -
    -

    Export Sv data for an Echoview acoustic variable by region

    - Source: R/EchoviewR.R - +
    +

    Export Sv data for an Echoview acoustic variable by region

    + Source: R/EchoviewR.R +
    EVExportRegionSv.Rd
    -
    - +

    This function exports the Sv values as a .csv file for an acoustic variable by region using COM scripting

    -
    - 
    EVExportRegionSv(EVFile, variableName, regionName, filePath)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    variableName

    Echoview variable name for which to extract the data

    regionName

    Echoview region name for which to extract the data

    filePath

    File path and name (.csv) to save the data

    - -

    Value

    +
    +

    Usage

    + 
    EVExportRegionSv(EVFile, variableName, regionName, filePath)
    +
    -

    A list object with one element. $msg message for processing log

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile EVImportRegionDef

    - +
    variableName
    +

    Echoview variable name for which to extract the data

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVImportRegionDef(EVFile = EVFile, evrFile = '~~/KAOS/off transect regions/20030114_1200000000.evr', regionName = 'region_1')
-EVExportRegionSv(EVFile = EVFile, variableName = '120 seabed and surface excluded', regionName = 'region_1', filePath = '~~/KAOS/EVExportRegionSv_example.csv')
-# }
    -
    - -
    +
    filePath
    +

    File path and name (.csv) to save the data

    + +
    +
    +

    Value

    + -
    -
    +

    A list object with one element. $msg message for processing log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVImportRegionDef

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVImportRegionDef(EVFile = EVFile, evrFile = '~~/KAOS/off transect regions/20030114_1200000000.evr', regionName = 'region_1')
+EVExportRegionSv(EVFile = EVFile, variableName = '120 seabed and surface excluded', regionName = 'region_1', filePath = '~~/KAOS/EVExportRegionSv_example.csv')
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportUnderlying.html b/docs/reference/EVExportUnderlying.html index e1e9f98..a1b86ee 100644 --- a/docs/reference/EVExportUnderlying.html +++ b/docs/reference/EVExportUnderlying.html @@ -1,205 +1,127 @@ - - - - - - - -Export underlying data for an acoustic variable — EVExportUnderlying • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Export underlying data for an acoustic variable — EVExportUnderlying • EchoviewR + Skip to contents + +
    -
    -
    -

    Export underlying data for an acoustic variable

    - Source: R/EchoviewR.R - +
    +

    Export underlying data for an acoustic variable

    + Source: R/EchoviewR.R +
    EVExportUnderlying.Rd
    -
    - +

    This function exports underlying data for an Echoview acoustic variable using COM scripting

    -
    - 
    EVExportUnderlying(EVFile, variableName, pingRange = c(-1, -1), filePath)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    variableName

    a string containing the name of an EV acoustic variable

    pingRange

    = c(-1,-1) ping range to export

    filePath

    a string containing the file path and name to save the exported data to

    - -

    Value

    +
    +

    Usage

    + 
    EVExportUnderlying(EVFile, variableName, pingRange = c(-1, -1), filePath)
    +
    -

    a list object with 1 element: message for progessing log

    - -

    Details

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    pingRange defaults are all pings i.e. start=-1 and stop=-1

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    variableName
    +

    a string containing the name of an EV acoustic variable

    -

    EVOpenFile

    - -

    Examples

    - 
    # NOT RUN {
-EVAppObj = COMCreate('EchoviewCom.EvApplication')
-EVFile = EVOpenFile(EVAppObj, '~~KAOS/KAOStemplate.EV')$EVFile
-EVExportUnderlying(EVFile = EVFile, variableName = '38 seabed and surface excluded', pingRange = c(1, 100), filePath = '~~Desktop/test.csv')
-# }
    -
    - +
    +

    Value

    + -
    -
    +

    a list object with 1 element: message for progessing log

    +
    +
    +

    Details

    +

    pingRange defaults are all pings i.e. start=-1 and stop=-1

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj = COMCreate('EchoviewCom.EvApplication')
+EVFile = EVOpenFile(EVAppObj, '~~KAOS/KAOStemplate.EV')$EVFile
+EVExportUnderlying(EVFile = EVFile, variableName = '38 seabed and surface excluded', pingRange = c(1, 100), filePath = '~~Desktop/test.csv')
+}
+
    +
    +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVExportWBST_FR.html b/docs/reference/EVExportWBST_FR.html index 345af40..2c27b91 100644 --- a/docs/reference/EVExportWBST_FR.html +++ b/docs/reference/EVExportWBST_FR.html @@ -1,206 +1,150 @@ - - - - - - +Export Wideband Single Targets Frequency Response — EVExportWBST_FR • EchoviewR + Skip to contents + -Export Wideband Single Targets Frequency Response — EVExportWBST_FR • EchoviewR +
    +
    +
    +

    Export Wideband Single Targets Frequency Response

    + Source: R/EVExportWBST_FR.R +
    EVExportWBST_FR.Rd
    +
    - - - +
    +

    This function exports the broadband single targets frequency response

    +
    +
    +

    Usage

    + 
    EVExportWBST_FR(
+  EVFile = EVFile,
+  STVar,
+  outfn,
+  AverageResults = 0,
+  MinMax = 0,
+  WindowSize = 1,
+  WindowUnit = 2,
+  EVVar
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    - - - +
    STVar
    +

    An Wideband Single Target Detection Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    +
    outfn
    +

    FIlename for the TS export

    - - - - - - - - -
    -
    - - -
    +
    MinMax
    +

    [Binary] 0 clears Include min and max. 1 selects Include min and max.

    -
    -
    -
    -

    Export Wideband Single Targets Frequency Response

    - Source: R/EVExportWBST_FR.R - -
    -
    - -

    This function exports the broadband single targets frequency response

    - -
    +
    WindowSize
    +

    Set the WIndow Size

    - 
    EVExportWBST_FR(EVFile = EVFile, STVar, outfn, AverageResults = 0,
-  MinMax = 0, WindowSize = 1, WindowUnit = 2, EVVar)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    STVar

    An Wideband Single Target Detection Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    outfn

    FIlename for the TS export

    MinMax

    Include Min and Max

    WindowSize

    Set the WIndow Size

    WindowUnit

    Unit of the window 0 = Meters, 1 = Pulse Lengths, 2 = Samples

    EVVar

    Specifies a TS pulse compressed wideband variable for frequency response calculations.

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - +
    WindowUnit
    +

    Unit of the window 0 = Meters, 1 = Pulse Lengths, 2 = Samples

    -

    Examples

    - 
    #To be added - Needs Example data
-#Starting Echoview
-echoview = StartEchoview()
    #> 2018-11-01 10:54:35: Opening Echoview
    #> Warning: Couldn't get clsid from the string
    #> Error: Invalid class string
    #Create a new EV File
-EVFile <- EVCreateNew(EVAppObj=echoview, dataFiles = "rawfile.raw")$EVFile
    #> 2018-11-01 10:54:35 : Creating new EV file
    #> Error in EVNewFile(EVAppObj = EVAppObj, templateFn = templateFn): object 'echoview' not found
    #Set the First and second Operand
-EVVar <- "Fileset 1: TS pulse compressed wideband pings T1"
-Operand2 <- "Fileset 1: angular position pulse compressed wideband pings T1"
-#Create a wideband single target detection varable
-ST <- EVSTWideband(EVFile=EVFile,EVVar=EVVar,Operand2=Operand2)
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
    # Change TS detection threshold
-ST <- EVSTWideband(EVFile=EVFile,EVVar=EVVar,Operand2=Operand2,TsThreshold=-90)
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
    #Export the single target frequency response
-EVExportWBST_FR(ST,"WB_ST_FR.csv",0,0,1,2,EVVar)
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = STVar): object 'ST' not found
    
-
    -
    - -
    +
    EVVar
    +

    Specifies a TS pulse compressed wideband variable for frequency response calculations.

    + +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+#To be added - Needs Example data
+#Starting Echoview
+echoview = StartEchoview()
+#Create a new EV File
+EVFile <- EVCreateNew(EVAppObj=echoview, dataFiles = "rawfile.raw")$EVFile
+#Set the First and second Operand
+EVVar <- "Fileset 1: TS pulse compressed wideband pings T1"
+Operand2 <- "Fileset 1: angular position pulse compressed wideband pings T1"
+#Create a wideband single target detection varable
+ST <- EVSTWideband(EVFile=EVFile,EVVar=EVVar,Operand2=Operand2)
+# Change TS detection threshold
+ST <- EVSTWideband(EVFile=EVFile,EVVar=EVVar,Operand2=Operand2,TsThreshold=-90)
+#Export the single target frequency response
+EVExportWBST_FR(ST,"WB_ST_FR.csv",0,0,1,2,EVVar)
+}
+
+
    +
    +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVFilesInFileset.html b/docs/reference/EVFilesInFileset.html index 3cb95be..14c3089 100644 --- a/docs/reference/EVFilesInFileset.html +++ b/docs/reference/EVFilesInFileset.html @@ -1,191 +1,115 @@ - - - - - - - -Find names of all raw files in a fileset — EVFilesInFileset • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Find names of all raw files in a fileset — EVFilesInFileset • EchoviewR + Skip to contents + +
    -
    -
    -

    Find names of all raw files in a fileset

    - Source: R/EchoviewR.R - +
    +

    Find names of all raw files in a fileset

    + Source: R/EchoviewR.R +
    EVFilesInFileset.Rd
    -
    - +

    This function returns the names of all .raw files in a fileset using COM scripting

    -
    - 
    EVFilesInFileset(EVFile, filesetName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    filesetName

    An Echoview fileset name

    - -

    Value

    +
    +

    Usage

    + 
    EVFilesInFileset(EVFile, filesetName)
    +
    -

    A character vector containing the names of all .raw files in the fileset

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    filesetName
    +

    An Echoview fileset name

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-file.names <- EVFilesInFileset(EVFile = EVFile, filesetName = '038-120-200')
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    A character vector containing the names of all .raw files in the fileset

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+file.names <- EVFilesInFileset(EVFile = EVFile, filesetName = '038-120-200')
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVFindFilesetByName.html b/docs/reference/EVFindFilesetByName.html index 7a84207..3ae57fe 100644 --- a/docs/reference/EVFindFilesetByName.html +++ b/docs/reference/EVFindFilesetByName.html @@ -1,191 +1,115 @@ - - - - - - - -Find an Echoview fileset in an Echoview file — EVFindFilesetByName • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Find an Echoview fileset in an Echoview file — EVFindFilesetByName • EchoviewR + Skip to contents + +
    -
    -
    -

    Find an Echoview fileset in an Echoview file

    - Source: R/EchoviewR.R - +
    +

    Find an Echoview fileset in an Echoview file

    + Source: R/EchoviewR.R +
    EVFindFilesetByName.Rd
    -
    - +

    This function finds an Echoview fileset in an Echoview file via COM scripting

    -
    - 
    EVFindFilesetByName(EVFile, filesetName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    filesetName

    Echoview fileset name to find

    - -

    Value

    +
    +

    Usage

    + 
    EVFindFilesetByName(EVFile, filesetName)
    +
    -

    a list object with two elements. $fileset: found fileset COM object, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVNewFile EVCreateNew EVCreateFileset EVOpenFile

    - +
    filesetName
    +

    Echoview fileset name to find

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVFileset <-EVFindFilesetByName(EVFile = EVFile, filesetName = '038-120-200')$filesetObj
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with two elements. $fileset: found fileset COM object, and $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVNewFile EVCreateNew EVCreateFileset EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVFileset <-EVFindFilesetByName(EVFile = EVFile, filesetName = '038-120-200')$filesetObj
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVFindFilesetTime.html b/docs/reference/EVFindFilesetTime.html index 3c8754a..d1e46c4 100644 --- a/docs/reference/EVFindFilesetTime.html +++ b/docs/reference/EVFindFilesetTime.html @@ -1,193 +1,117 @@ - - - - - - - -Find the time and date of the start and end of an Echoview fileset — EVFindFilesetTime • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Find the time and date of the start and end of an Echoview fileset — EVFindFilesetTime • EchoviewR + Skip to contents + +
    -
    -
    -

    Find the time and date of the start and end of an Echoview fileset

    - Source: R/EchoviewR.R - +
    +

    Find the time and date of the start and end of an Echoview fileset

    + Source: R/EchoviewR.R +
    EVFindFilesetTime.Rd
    -
    - +

    This function finds the date and time of the first and last measurement in a fileset using COM scripting

    -
    - 
    EVFindFilesetTime(EVFile, filesetName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    filesetName

    An Echoview fileset name

    - -

    Value

    +
    +

    Usage

    + 
    EVFindFilesetTime(EVFile, filesetName)
    +
    -

    A list object with two elements $start.time: The date and time of the first measurement in the fileset, and $end.time: The date and time of the last measurement in the fileset

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    filesetName
    +

    An Echoview fileset name

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-survey.time = EVFindFilesetTime(EVFile = EVFile, filesetName = '038-120-200')
-start.time <- survey.time$start.time
-end.time <- survey.time$end.time
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    A list object with two elements $start.time: The date and time of the first measurement in the fileset, and $end.time: The date and time of the last measurement in the fileset

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+survey.time = EVFindFilesetTime(EVFile = EVFile, filesetName = '038-120-200')
+start.time <- survey.time$start.time
+end.time <- survey.time$end.time
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVFindLineByName.html b/docs/reference/EVFindLineByName.html index 71cd15d..c9c1c8c 100644 --- a/docs/reference/EVFindLineByName.html +++ b/docs/reference/EVFindLineByName.html @@ -1,191 +1,115 @@ - - - - - - - -Find an EV Line object by name — EVFindLineByName • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Find an EV Line object by name — EVFindLineByName • EchoviewR + Skip to contents + +
    -
    -
    -

    Find an EV Line object by name

    - Source: R/EchoviewR.R - +
    +

    Find an EV Line object by name

    + Source: R/EchoviewR.R +
    EVFindLineByName.Rd
    -
    - +

    This function finds an EV Line in an EV file object by name using COM scripting.

    -
    - 
    EVFindLineByName(EVFile, lineName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    lineName

    a string containing the name of the line to find

    - -

    Value

    +
    +

    Usage

    + 
    EVFindLineByName(EVFile, lineName)
    +
    -

    an Echoview line object

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    lineName
    +

    a string containing the name of the line to find

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVLine <- EVFindLineByName(EVFile = EVFile, lineName = "Fixed depth 250 m")
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    an Echoview line object

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVLine <- EVFindLineByName(EVFile = EVFile, lineName = "Fixed depth 250 m")
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVFindRegionByName.html b/docs/reference/EVFindRegionByName.html index 18d3466..da4b0a3 100644 --- a/docs/reference/EVFindRegionByName.html +++ b/docs/reference/EVFindRegionByName.html @@ -1,192 +1,116 @@ - - - - - - - -Finds an Echoview region by name — EVFindRegionByName • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Finds an Echoview region by name — EVFindRegionByName • EchoviewR + Skip to contents + +
    -
    -
    -

    Finds an Echoview region by name

    - Source: R/EchoviewR.R - +
    +

    Finds an Echoview region by name

    + Source: R/EchoviewR.R +
    EVFindRegionByName.Rd
    -
    - +

    This function finds an Echoview region by name using COM scripting

    -
    - 
    EVFindRegionByName(EVFile, regionName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    regionName

    a string containing the name of the region to find

    - -

    Value

    - -

    the Echoview region object

    - -

    References

    +
    +

    Usage

    + 
    EVFindRegionByName(EVFile, regionName)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    EVOpenFile

    - -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
    regionName
    
+
    a string containing the name of the region to find
    
 
-testRegion <- EVFindRegionByName(EVFile, "Region1")
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    the Echoview region object

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+testRegion <- EVFindRegionByName(EVFile, "Region1")
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVFindRegionClass.html b/docs/reference/EVFindRegionClass.html index d5d103d..d781038 100644 --- a/docs/reference/EVFindRegionClass.html +++ b/docs/reference/EVFindRegionClass.html @@ -1,189 +1,113 @@ - - - - - - - -Find the class of an Echoview region object — EVFindRegionClass • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Find the class of an Echoview region object — EVFindRegionClass • EchoviewR + Skip to contents + +
    -
    -
    -

    Find the class of an Echoview region object

    - Source: R/EchoviewR.R - +
    +

    Find the class of an Echoview region object

    + Source: R/EchoviewR.R +
    EVFindRegionClass.Rd
    -
    - +

    This function finds the class of an Echoview region object using COM scripting.

    -
    - 
    EVFindRegionClass(evRegion)
    - -

    Arguments

    - - - - - - -
    evRegion

    and Echoview Region object

    - -

    Value

    - -

    a string containing the class of the region

    - -

    References

    +
    +

    Usage

    + 
    EVFindRegionClass(evRegion)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    +

    Arguments

    +
    evRegion
    +

    and Echoview Region object

    -

    EVOpenFile EVFindRegionByName

    +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-
-ev.region <- EVFindRegionByName(EVFile, "Region1")
-EVFindRegionClass(ev.region)
-# }
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVFindRegionByName

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+ev.region <- EVFindRegionByName(EVFile, "Region1")
+EVFindRegionClass(ev.region)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVFishTracking.html b/docs/reference/EVFishTracking.html index 5aff5e0..eac09b1 100644 --- a/docs/reference/EVFishTracking.html +++ b/docs/reference/EVFishTracking.html @@ -1,247 +1,231 @@ - - - - - - +Detect Fish Tracks — EVFishTracking • EchoviewR + Skip to contents + -Detect Fish Tracks — EVFishTracking • EchoviewR +
    +
    +
    +

    Detect Fish Tracks

    + Source: R/EVFishTracking.R +
    EVFishTracking.Rd
    +
    - - - +
    +

    This function runs fish track detection on an single target echogram +Fish track algorithms and settings are explained in the [Echoview Help File]('https://support.echoview.com/WebHelp/Echoview.htm')

    +
    +
    +

    Usage

    + 
    EVFishTracking(
+  EVFile,
+  EVVar,
+  FishTrackRegionClass = "Unclassified regions",
+  export = NULL,
+  DataDimensions = NULL,
+  Alpha.MajorAxis = NULL,
+  Alpha.MinorAxis = NULL,
+  Alpha.Range = NULL,
+  Beta.MajorAxis = NULL,
+  Beta.MinorAxis = NULL,
+  Beta.Range = NULL,
+  ExclusionDistance.MajorAxis = NULL,
+  ExclusionDistance.MinorAxis = NULL,
+  ExclusionDistance.Range = NULL,
+  MissedPingExpansion.MajorAxis = NULL,
+  MissedPingExpansion.MinorAxis = NULL,
+  MissedPingExpansion.Range = NULL,
+  Weights.MajorAxis = NULL,
+  Weights.MinorAxis = NULL,
+  Weights.Range = NULL,
+  Weights.TS = NULL,
+  Weights.PingGap = NULL,
+  MinimumTargets = NULL,
+  MinimumPings = NULL,
+  MaximumGap = NULL
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    - - - +
    EVVar
    +

    An Echoview single target variable as a character string

    +
    FishTrackRegionClass
    +

    string indicating the region class name for the fish tracks to be assigned

    - - - - - - - - -
    -
    - - -
    +
    DataDimensions
    +

    numeric Determine which algorithim is used for fish tracks. Accepted values are 2 (single or dual beam) or 4 (split beam)

    -
    -
    -
    -

    Detect Fish Tracks

    - Source: R/EVFishTracking.R - -
    -
    - -

    This function runs a bottom detection on an echogram -Bottom algorithms and settings are explained in the [Echoview Help File]('https://support.echoview.com/WebHelp/Reference/Algorithms/Line_picking_algorithm.htm')

    - -
    +
    Alpha.MajorAxis
    +

    numeric Increases Alpha gain setting of Major Axis

    - 
    EVFishTracking(EVFile, EVVar,
-  FishTrackRegionClass = "Unclassified regions", export = NULL,
-  DataDimensions = NULL, Alpha.MajorAxis = NULL,
-  Alpha.MinorAxis = NULL, Alpha.Range = NULL, Beta.MajorAxis = NULL,
-  Beta.MinorAxis = NULL, Beta.Range = NULL,
-  ExclusionDistance.MajorAxis = NULL,
-  ExclusionDistance.MinorAxis = NULL, ExclusionDistance.Range = NULL,
-  MissedPingExpansion.MajorAxis = NULL,
-  MissedPingExpansion.MinorAxis = NULL,
-  MissedPingExpansion.Range = NULL, Weights.MajorAxis = NULL,
-  Weights.MinorAxis = NULL, Weights.Range = NULL, Weights.TS = NULL,
-  Weights.PingGap = NULL, MinimumTargets = NULL, MinimumPings = NULL,
-  MaximumGap = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    EVVar

    An Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    LineName

    Character of the output name for the detected Line

    algorithm

    numeric [0 - 2] Defines which bottom detection algorithm should be used: 0 for Delta Sv, 1 for Maximum Sv, 2 for Best bottom Candidate

    StartDepth

    numeric [m] Minimum bottom detection depth

    StopDepth

    numeric [m] maximum bottom detection detpth

    MinSv

    numeric [dB] minimum detection Sv

    UseBackstep

    Boolean [True or False]

    BackstepRange

    numeric [m] Backstep range

    DiscriminationLevel

    numeric [dB] Minimum discrimination threshold

    MaxDropOuts

    numeric [samples] Maximum number of dropout samples before bottom detection fails

    windowRadius

    numeric [samples] Search window size

    PeakThreshold

    numeric [dB] Threshold for peak detection

    MinPeakAssymmetry

    numeric

    replaceOldBottom

    Boolean (TRUE or FALSE) If TRUE and a line with the same name as LineName already exists, the old line will be overwritten with the new one

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - +
    Alpha.MinorAxis
    +

    numeric Increases Alpha gain setting of Minor Axis

    -

    Examples

    - 
    #To be added - Needs Example data
-#Starting Echoview
-echoview = StartEchoview()
    #> 2018-11-01 10:54:38: Opening Echoview
    #> Warning: Couldn't get clsid from the string
    #> Error: Invalid class string
    #Create a new EV File
-EVFile <- EVCreateNew(EVAppObj=echoview, dataFiles = "rawfile.raw")$EVFile
    #> 2018-11-01 10:54:38 : Creating new EV file
    #> Error in EVNewFile(EVAppObj = EVAppObj, templateFn = templateFn): object 'echoview' not found
    Varname <- "Fileset 1: Sv pulse compressed wideband pings T1"
-bottom <- EVBottomDetection(EVFile, EVVar=Varname, LineName="Bottom")
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
    # Change the algorithm to Best bottom candidate
-bottom <- EVBottomDetection(EVFile, EVVar=Varname, LineName="Bottom",algorithm=2)
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
    
-
    -
    - -
    +
    Alpha.Range
    +

    numeric Increases Alpha gain setting of Range

    -
    -
    + +
    Beta.MajorAxis
    +

    numeric Increases Beta gain setting of Major Axis

    + + +
    Beta.MinorAxis
    +

    numeric Increases Beta gain setting of Minor Axis

    + + +
    Beta.Range
    +

    numeric Increases Beta gain setting of Range

    + + +
    ExclusionDistance.MajorAxis
    +

    numeric Increases distance value of major axis in target gate parameters

    + + +
    ExclusionDistance.MinorAxis
    +

    numeric Increases distance value of minor axis in target gate parameters

    + + +
    ExclusionDistance.Range
    +

    numeric Increases distance value of range in target gate parameters

    + + +
    MissedPingExpansion.MajorAxis
    +

    numeric Increases expansion value of major axis in target gate parameters

    + + +
    MissedPingExpansion.MinorAxis
    +

    numeric Increases expansion value ofminor axis in target gate parameters

    + + +
    MissedPingExpansion.Range
    +

    numeric Increases expansion value of missed pings range in target gate parameters. 0 disables missed ping expansion

    + + +
    Weights.MajorAxis
    +

    numeric 1-100 Assigns the weighting of the major axis

    + + +
    Weights.MinorAxis
    +

    numeric 1-100 Assigns the weighting of the minor axis

    + + +
    Weights.Range
    +

    numeric 1-100 Assigns the weighting of the range

    + + +
    Weights.TS
    +

    numeric 1-100 Assigns the weighting of the target strength

    + + +
    Weights.PingGap
    +

    numeric 1-100

    + + +
    MinimumTargets
    +

    numeric Minimum number of single targets to be considered a fish track

    + + +
    MinimumPings
    +

    numeric Maximum number of pings in a track

    + + +
    MaximumGap
    +

    numeric Maximum ping gap between tracks

    + +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVFishTracking(EVFile = EvFile,
+EVVar = "Single target detection - wideband 1",
+FishTrackRegionClass = "FishTracks",
+MinimumTargets = 5,
+export = "C:/FishTracking/Exports/FishTracks.csv")
+}
+
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVGetCalibrationFileName.html b/docs/reference/EVGetCalibrationFileName.html index b9ffb34..c03a0f3 100644 --- a/docs/reference/EVGetCalibrationFileName.html +++ b/docs/reference/EVGetCalibrationFileName.html @@ -1,191 +1,115 @@ - - - - - - - -Gets the calibration file name of a fileset — EVGetCalibrationFileName • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Gets the calibration file name of a fileset — EVGetCalibrationFileName • EchoviewR + Skip to contents + +
    -
    -
    -

    Gets the calibration file name of a fileset

    - Source: R/EchoviewR.R - +
    +

    Gets the calibration file name of a fileset

    + Source: R/EchoviewR.R +
    EVGetCalibrationFileName.Rd
    -
    - +

    This function gets the calibration file name of a filesset using COM scripting

    -
    - 
    EVGetCalibrationFileName(EVFile, filesetName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    filesetName

    a string containing the name of the Echoview fileset

    - -

    Value

    +
    +

    Usage

    + 
    EVGetCalibrationFileName(EVFile, filesetName)
    +
    -

    an object: returns the calibration file name

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    filesetName
    +

    a string containing the name of the Echoview fileset

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVGetCalibrationFileName(EVFile = EVFile, filesetName = "038-120-200")
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    an object: returns the calibration file name

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVGetCalibrationFileName(EVFile = EVFile, filesetName = "038-120-200")
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVImportLine.html b/docs/reference/EVImportLine.html index 011cc85..7fbcaaf 100644 --- a/docs/reference/EVImportLine.html +++ b/docs/reference/EVImportLine.html @@ -1,186 +1,115 @@ - - - - - - - -Import an Echoview line (EVL format) file — EVImportLine • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Import an Echoview line (EVL format) file — EVImportLine • EchoviewR + Skip to contents + +
    -
    -
    -

    Import an Echoview line (EVL format) file

    - Source: R/EVImportLine.R - +
    +

    Import an Echoview line (EVL format) file

    + Source: R/EVImportLine.R +
    EVImportLine.Rd
    -
    - +

    This function imports an Echoview line (.EVL) format line into Echoview and can rename the imported line or replace a line.

    -
    - 
    EVImportLine(EVFile, pathAndFn = NULL, lineName = NULL,
-  overwriteExistingLine = TRUE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    ("COMIDispatch) An Echoview file COM object

    pathAndFn

    = NULL (character) path and file name of an EVL file

    lineName

    = NULL (character) desired line name

    overwriteExistingLine

    = TRUE (boolean) overwrite an existing line named lineName

    - -

    Value

    +
    +

    Usage

    + 
    EVImportLine(
+  EVFile,
+  pathAndFn = NULL,
+  lineName = NULL,
+  overwriteExistingLine = TRUE
+)
    +
    -

    list $lineObj=COM object for the imported line (class COMIDispatch), msg= vector of messages)

    - -

    Note

    +
    +

    Arguments

    +
    EVFile
    +

    ("COMIDispatch) An Echoview file COM object

    -

    Overwriting an existing line only works with editable lines.

    + +
    pathAndFn
    +

    = NULL (character) path and file name of an EVL file

    + + +
    lineName
    +

    = NULL (character) desired line name

    + + +
    overwriteExistingLine
    +

    = TRUE (boolean) overwrite an existing line named lineName

    + +
    +
    +

    Value

    -
    - +
    +

    Note

    +

    Overwriting an existing line only works with editable lines.

    +
    -
  • Note
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVImportRegionDef.html b/docs/reference/EVImportRegionDef.html index b98c9bd..ee0d922 100644 --- a/docs/reference/EVImportRegionDef.html +++ b/docs/reference/EVImportRegionDef.html @@ -1,192 +1,126 @@ - - - - - - - -Import an Echoview region definitions file (.evr) — EVImportRegionDef • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Import an Echoview region definitions file (.evr) — EVImportRegionDef • EchoviewR + Skip to contents + +
    -
    -
    -

    Import an Echoview region definitions file (.evr)

    - Source: R/EVImportRegionDef.R - +
    +

    Import an Echoview region definitions file (.evr)

    + Source: R/EVImportRegionDef.R +
    EVImportRegionDef.Rd
    -
    - +

    This function imports a region definitions file (.evr) using COM scripting

    -
    - 
    EVImportRegionDef(EVFile, evrFile)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    evrFile

    An Echoview region definitions file (.evr) path and name

    - -

    Value

    +
    +

    Usage

    + 
    EVImportRegionDef(EVFile, evrFile)
    +
    -

    If successful, A list object with three elements. $regionCOMObjs a list comprising of the COM object of each imported region; -$regionMeta metadata of the regions imported: the region ID, region name and region class, and $msg message for processing log

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    evrFile
    +

    An Echoview region definitions file (.evr) path and name

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVImportRegionDef(EVFile = EVFile, evrFile = '~~/KAOS/off transect regions/20030114_1200000000.evr')
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    If successful, A list object with three elements. $regionCOMObjs a list comprising of the COM object of each imported region; +$regionMeta metadata of the regions imported: the region ID, region name and region class, and $msg message for processing log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+#> Error in eval(expr, envir, enclos): object 'EVAppObj' not found
+EVImportRegionDef(EVFile = EVFile, evrFile = '~~/KAOS/off transect regions/20030114_1200000000.evr')
+#> Warning: 2024-05-14 12:25:49.206251 : EVR file not found.
+#> $regionCOMObjs
+#> [1] NA
+#> 
+#> $regionMeta
+#> [1] NA
+#> 
+#> $msg
+#> [1] "2024-05-14 12:25:49.206251 : EVR file not found."
+#> 
+
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVIntegrationByRegionsByCellsExport.html b/docs/reference/EVIntegrationByRegionsByCellsExport.html index 25fbff3..8ed13f2 100644 --- a/docs/reference/EVIntegrationByRegionsByCellsExport.html +++ b/docs/reference/EVIntegrationByRegionsByCellsExport.html @@ -1,204 +1,133 @@ - - - - - - - -Export integration by regions by cells from an Echoview acoustic variable — EVIntegrationByRegionsByCellsExport • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Export integration by regions by cells from an Echoview acoustic variable — EVIntegrationByRegionsByCellsExport • EchoviewR + Skip to contents + +
    -
    -
    -

    Export integration by regions by cells from an Echoview acoustic variable

    - Source: R/EchoviewR.R - +
    +

    Export integration by regions by cells from an Echoview acoustic variable

    + Source: R/EchoviewR.R +
    EVIntegrationByRegionsByCellsExport.Rd
    -
    - +

    This function performs integration by regions by cells for a specified region class and exports the results using COM scripting.

    -
    - 
    EVIntegrationByRegionsByCellsExport(EVFile, acoVarName, regionClassName,
-  exportFn, dataThreshold = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file object

    acoVarName

    A string containing the name of an Echoview acoustic variable

    regionClassName

    A string containing the name of an Echoview region class

    exportFn

    export filename and path

    dataThreshold

    An optional data threshold for export

    - -

    Value

    +
    +

    Usage

    + 
    EVIntegrationByRegionsByCellsExport(
+  EVFile,
+  acoVarName,
+  regionClassName,
+  exportFn,
+  dataThreshold = NULL
+)
    +
    -

    a list object with one element, $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    acoVarName
    +

    A string containing the name of an Echoview acoustic variable

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVIntegrationByRegionsByCellsExport(EVFile, "120 aggregations", "aggregations", exportFn = "~~/KAOS/EVIntegrationByRegionsExport_example.csv")
-# }
    -
    - -
    +
    exportFn
    +

    export filename and path

    -
    -
    + +
    dataThreshold
    +

    An optional data threshold for export

    + +
    +
    +

    Value

    + + +

    a list object with one element, $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVIntegrationByRegionsByCellsExport(EVFile, "120 aggregations", "aggregations", exportFn = "~~/KAOS/EVIntegrationByRegionsExport_example.csv")
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVIntegrationByRegionsExport.html b/docs/reference/EVIntegrationByRegionsExport.html index f483bc1..50e5624 100644 --- a/docs/reference/EVIntegrationByRegionsExport.html +++ b/docs/reference/EVIntegrationByRegionsExport.html @@ -1,204 +1,133 @@ - - - - - - - -Export integration by regions from an Echoview acoustic variable — EVIntegrationByRegionsExport • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Export integration by regions from an Echoview acoustic variable — EVIntegrationByRegionsExport • EchoviewR + Skip to contents + +
    -
    -
    -

    Export integration by regions from an Echoview acoustic variable

    - Source: R/EchoviewR.R - +
    +

    Export integration by regions from an Echoview acoustic variable

    + Source: R/EchoviewR.R +
    EVIntegrationByRegionsExport.Rd
    -
    - +

    This function performs integration by regions and exports the results using COM scripting.

    -
    - 
    EVIntegrationByRegionsExport(EVFile, acoVarName, regionClassName, exportFn,
-  dataThreshold = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file object

    acoVarName

    A string containing the name of an Echoview acoustic variable

    regionClassName

    A string containing the name of an Echoview region class

    exportFn

    export filename and path

    dataThreshold

    An optional data threshold for export

    - -

    Value

    +
    +

    Usage

    + 
    EVIntegrationByRegionsExport(
+  EVFile,
+  acoVarName,
+  regionClassName,
+  exportFn,
+  dataThreshold = NULL
+)
    +
    -

    a list object with one element, $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    acoVarName
    +

    A string containing the name of an Echoview acoustic variable

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVIntegrationByRegionsExport(EVFile, "120 aggregations", "aggregations", exportFn = "~~/KAOS/EVIntegrationByRegionsExport_example.csv")
-# }
    -
    - -
    +
    exportFn
    +

    export filename and path

    -
    -
    + +
    dataThreshold
    +

    An optional data threshold for export

    + +
    +
    +

    Value

    + + +

    a list object with one element, $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVIntegrationByRegionsExport(EVFile, "120 aggregations", "aggregations", exportFn = "~~/KAOS/EVIntegrationByRegionsExport_example.csv")
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVLineExportFromAcousticVarEVL.html b/docs/reference/EVLineExportFromAcousticVarEVL.html index 0f796c8..bc0813f 100644 --- a/docs/reference/EVLineExportFromAcousticVarEVL.html +++ b/docs/reference/EVLineExportFromAcousticVarEVL.html @@ -1,199 +1,127 @@ - - - - - - - -Export an Echoview line file for an existing line associated with an Acoustic Variable. — EVLineExportFromAcousticVarEVL • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Export an Echoview line file for an existing line associated with an Acoustic Variable. — EVLineExportFromAcousticVarEVL • EchoviewR + Skip to contents + +
    -
    -
    -

    Export an Echoview line file for an existing line associated with an Acoustic Variable.

    - Source: R/EchoviewR.R - +
    +

    Export an Echoview line file for an existing line associated with an Acoustic Variable.

    + Source: R/EchoviewR.R +
    EVLineExportFromAcousticVarEVL.Rd
    -
    - +

    This function exports an EV line definition file (.evl) for a line associated with an acoustic variable.

    -
    - 
    EVLineExportFromAcousticVarEVL(EVFile, acoVar, lineNameToExport,
-  pathAndFileName)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    acoVar

    Acoustic variable name that the line to be exported is associated with.

    lineNameToExport

    a string containing the name of the line to export

    pathAndFileName

    Path and filename of evl file.

    - -

    References

    +
    +

    Usage

    + 
    EVLineExportFromAcousticVarEVL(
+  EVFile,
+  acoVar,
+  lineNameToExport,
+  pathAndFileName
+)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    EVFindLineByName EVCreateEditableLine

    - -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj, '~\\example1.EV')$EVFile
-
-EVLineExportFromAcousticVarEVL(EVFile=EVFile,
-   acoVar='120 seabed and surface excluded',
-   lineNameToExport='Fixed depth 250 m',
-   pathAndFileName=  '~~KAOS/test2.evl')
-# }
    
-
    -
    - -
    -
    -
    +
    lineNameToExport
    +

    a string containing the name of the line to export

    + + +
    pathAndFileName
    +

    Path and filename of evl file.

    + +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVFindLineByName EVCreateEditableLine

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj, '~\\example1.EV')$EVFile
+
+EVLineExportFromAcousticVarEVL(EVFile=EVFile,
+   acoVar='120 seabed and surface excluded',
+   lineNameToExport='Fixed depth 250 m',
+   pathAndFileName=  '~~KAOS/test2.evl')
+}
+
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVNewAcousticVar.html b/docs/reference/EVNewAcousticVar.html index 9b7aeea..a4ea616 100644 --- a/docs/reference/EVNewAcousticVar.html +++ b/docs/reference/EVNewAcousticVar.html @@ -1,196 +1,120 @@ - - - - - - - -Add a new acoustic variable — EVNewAcousticVar • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Add a new acoustic variable — EVNewAcousticVar • EchoviewR + Skip to contents + +
    -
    -
    -

    Add a new acoustic variable

    - Source: R/EchoviewR.R - +
    +

    Add a new acoustic variable

    + Source: R/EchoviewR.R +
    EVNewAcousticVar.Rd
    -
    - +

    This function adds a new acoustic variable using COM scripting

    -
    - 
    EVNewAcousticVar(EVFile, oldVarName, enum)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    oldVarName

    a string containing the name of the acoustic variable to base the new variable on

    enum

    Enum code for operator. See Echoview help file on EOperator for enum codes.

    - -

    Value

    +
    +

    Usage

    + 
    EVNewAcousticVar(EVFile, oldVarName, enum)
    +
    -

    an object: returns the new variable

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    oldVarName
    +

    a string containing the name of the acoustic variable to base the new variable on

    -

    Examples

    - 
    # NOT RUN {
-#create a 7x7 convolution of a variable
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVNewAcousticVar(EVFile = EVFile, oldVarName = "38 seabed and surface excluded", enum = 43)
-# }
    -
    - +
    +

    Value

    + -
    -
    +

    an object: returns the new variable

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+#create a 7x7 convolution of a variable
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVNewAcousticVar(EVFile = EVFile, oldVarName = "38 seabed and surface excluded", enum = 43)
+}
+
    +
    +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVNewFile.html b/docs/reference/EVNewFile.html index 689b436..7d5fea9 100644 --- a/docs/reference/EVNewFile.html +++ b/docs/reference/EVNewFile.html @@ -1,184 +1,110 @@ - - - - - - - -Create a new Echoview file (.EV) — EVNewFile • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Create a new Echoview file (.EV) — EVNewFile • EchoviewR + Skip to contents + +
    -
    -
    -

    Create a new Echoview file (.EV)

    - Source: R/EchoviewR.R - +
    +

    Create a new Echoview file (.EV)

    + Source: R/EchoviewR.R +
    EVNewFile.Rd
    -
    - +

    This function creates a new Echoview file (.EV) via COM scripting which may be created from a template file if available

    -
    - 
    EVNewFile(EVAppObj, templateFn = NULL)
    - -

    Arguments

    - - - - - - - - - - -
    EVAppObj

    An EV application COM object arising from the call COMCreate('EchoviewCom.EvApplication')

    templateFn

    full path and filename for an Echoview template

    - -

    Value

    +
    +

    Usage

    + 
    EVNewFile(EVAppObj, templateFn = NULL)
    +
    -

    a list object with two elements. $EVFile: EVFile COM object for the newly created Echovie file, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVAppObj
    +

    An EV application COM object arising from the call COMCreate('EchoviewCom.EvApplication')

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    + +
    templateFn
    +

    full path and filename for an Echoview template

    + +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj=COMCreate('EchoviewCom.EvApplication')
-EVFile=EVNewFile(EVAppObj)$EVFile
-# }
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj=COMCreate('EchoviewCom.EvApplication')
+EVFile=EVNewFile(EVAppObj)$EVFile
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVNewFixedDepthLine.html b/docs/reference/EVNewFixedDepthLine.html index f758e50..633b58a 100644 --- a/docs/reference/EVNewFixedDepthLine.html +++ b/docs/reference/EVNewFixedDepthLine.html @@ -1,197 +1,121 @@ - - - - - - - -Creates a new fixed depth Echoview line — EVNewFixedDepthLine • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Creates a new fixed depth Echoview line — EVNewFixedDepthLine • EchoviewR + Skip to contents + +
    -
    -
    -

    Creates a new fixed depth Echoview line

    - Source: R/EchoviewR.R - +
    +

    Creates a new fixed depth Echoview line

    + Source: R/EchoviewR.R +
    EVNewFixedDepthLine.Rd
    -
    - +

    This function creates a new Echoview line at a fixed depth using COM scripting

    -
    - 
    EVNewFixedDepthLine(EVFile, depth, lineName)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    depth

    an integer specifying the fixed depth of the new line

    lineName

    a string containing the name for the new line

    - -

    Value

    +
    +

    Usage

    + 
    EVNewFixedDepthLine(EVFile, depth, lineName)
    +
    -

    returns the EV Line object

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    depth
    +

    an integer specifying the fixed depth of the new line

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
 
-#create a new line at 50m depth named "testline"
-newLine <- EVNewFixedDepthLine(EVFile = EVFile, depth = 50, lineName = "testline")
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    returns the EV Line object

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+#create a new line at 50m depth named "testline"
+newLine <- EVNewFixedDepthLine(EVFile = EVFile, depth = 50, lineName = "testline")
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVNewLineRelativeRegion.html b/docs/reference/EVNewLineRelativeRegion.html index af8c112..e1bbaa3 100644 --- a/docs/reference/EVNewLineRelativeRegion.html +++ b/docs/reference/EVNewLineRelativeRegion.html @@ -1,219 +1,150 @@ - - - - - - - -Creates a new line relative region in the current variable — EVNewLineRelativeRegion • EchoviewR +Creates a new line relative region in the current variable — EVNewLineRelativeRegion • EchoviewR + Skip to contents + - - - +
    +
    +
    +

    Creates a new line relative region in the current variable

    + Source: R/EchoviewR.R +
    EVNewLineRelativeRegion.Rd
    +
    +
    +

    This function creates a new line relative region in the current variable using COM scripting. The upper and lower depths are specified using Echoview line objects (these must already exist). Left and right bounds are optionally specified using ping number.

    +
    +
    +

    Usage

    + 
    EVNewLineRelativeRegion(
+  EVFile,
+  varName,
+  regionName,
+  line1,
+  line2,
+  firstPing = NA,
+  lastPing = NA
+)
    +
    - +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    - - +
    varName
    +

    a string containing the name of the acoustic variable to create the region in

    - - +
    regionName
    +

    a string containing the name to assign to the new region

    - - - - - - -
    -
    - +
    line1
    +

    a string containing the name of the upper line limit

    - -
    -
    -
    -
    -

    Creates a new line relative region in the current variable

    - Source: R/EchoviewR.R - -
    +
    line2
    +

    a string containing the name of the lower line limit

    -
    - -

    This function creates a new line relative region in the current variable using COM scripting. The upper and lower depths are specified using Echoview line objects (these must already exist). Left and right bounds are optionally specified using ping number.

    - -
    - 
    EVNewLineRelativeRegion(EVFile, varName, regionName, line1, line2,
-  firstPing = NA, lastPing = NA)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    varName

    a string containing the name of the acoustic variable to create the region in

    regionName

    a string containing the name to assign to the new region

    line1

    a string containing the name of the upper line limit

    line2

    a string containing the name of the lower line limit

    firstPing

    an optional integer for the ping to begin the region at

    lastPing

    an optional integer for the ping to end the region at

    - -

    Value

    +
    firstPing
    +

    an optional integer for the ping to begin the region at

    -

    returns the EV Region object

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    lastPing
    +

    an optional integer for the ping to end the region at

    -

    EVOpenFile

    +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-
-#create a region between pings 1 - 100 and depths 20-250m
-newRegion <- EVNewLineRelativeRegion(EVFile,
-"38 seabed and surface excluded", "test",
-"Fixed depth 6 m", "Fixed depth 250 m", 1, 100)
-
-#create an unbounded region between depths 250-750m
-newRegion <- EVNewLineRelativeRegion(EVFile, "38 seabed and surface excluded", "test", "Fixed depth 6 m", "Fixed depth 250 m")
-# }
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+#create a region between pings 1 - 100 and depths 20-250m
+newRegion <- EVNewLineRelativeRegion(EVFile, 
+"38 seabed and surface excluded", "test", 
+"Fixed depth 6 m", "Fixed depth 250 m", 1, 100)
+
+#create an unbounded region between depths 250-750m
+newRegion <- EVNewLineRelativeRegion(EVFile, "38 seabed and surface excluded", "test", "Fixed depth 6 m", "Fixed depth 250 m")
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVNewRegionClass.html b/docs/reference/EVNewRegionClass.html index ba41e7a..fadc3d1 100644 --- a/docs/reference/EVNewRegionClass.html +++ b/docs/reference/EVNewRegionClass.html @@ -1,191 +1,115 @@ - - - - - - - -Create a new Echoview region class — EVNewRegionClass • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Create a new Echoview region class — EVNewRegionClass • EchoviewR + Skip to contents + +
    -
    -
    -

    Create a new Echoview region class

    - Source: R/EchoviewR.R - +
    +

    Create a new Echoview region class

    + Source: R/EchoviewR.R +
    EVNewRegionClass.Rd
    -
    - +

    This function creates a new region class using COM scripting

    -
    - 
    EVNewRegionClass(EVFile, className)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    className

    The name of the new Echoview region class

    - -

    Value

    +
    +

    Usage

    + 
    EVNewRegionClass(EVFile, className)
    +
    -

    A list object with one element. $msg message for processing log

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    className
    +

    The name of the new Echoview region class

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVNewRegionClass(EVFile = EVFile, className = 'test_class')
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    A list object with one element. $msg message for processing log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVNewRegionClass(EVFile = EVFile, className = 'test_class')
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVOpenFile.html b/docs/reference/EVOpenFile.html index 3553479..a12d665 100644 --- a/docs/reference/EVOpenFile.html +++ b/docs/reference/EVOpenFile.html @@ -1,184 +1,110 @@ - - - - - - - -Open an existing Echoview file (.EV) — EVOpenFile • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Open an existing Echoview file (.EV) — EVOpenFile • EchoviewR + Skip to contents + +
    -
    -
    -

    Open an existing Echoview file (.EV)

    - Source: R/EchoviewR.R - +
    +

    Open an existing Echoview file (.EV)

    + Source: R/EchoviewR.R +
    EVOpenFile.Rd
    -
    - +

    This function opens an existing Echoview (.EV) file using COM scripting.

    -
    - 
    EVOpenFile(EVAppObj, fileName)
    - -

    Arguments

    - - - - - - - - - - -
    EVAppObj

    An EV application COM object arising from the call COMCreate('EchoviewCom.EvApplication')

    fileName

    An Echoview file path and name.

    - -

    Value

    +
    +

    Usage

    + 
    EVOpenFile(EVAppObj, fileName)
    +
    -

    a list object with two elements. $EVFile: EVFile COM object, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVAppObj
    +

    An EV application COM object arising from the call COMCreate('EchoviewCom.EvApplication')

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    + +
    fileName
    +

    An Echoview file path and name.

    + +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')
-# }
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVPingSubset.html b/docs/reference/EVPingSubset.html index 59b00ff..4ff03c3 100644 --- a/docs/reference/EVPingSubset.html +++ b/docs/reference/EVPingSubset.html @@ -1,195 +1,120 @@ - - - - - - - -Control an Echoview ping subset virtual variable using COM scripting. — EVPingSubset • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Control an Echoview ping subset virtual variable using COM scripting. — EVPingSubset • EchoviewR + Skip to contents + +
    -
    -
    -

    Control an Echoview ping subset virtual variable using COM scripting.

    - Source: R/EVPingSubset.R - +
    +

    Control an Echoview ping subset virtual variable using COM scripting.

    + Source: R/EVPingSubset.R +
    EVPingSubset.Rd
    -
    - +

    This function opens an existing Echoview (.EV) file using COM scripting.

    -
    - 
    EVPingSubset(EVFile, acoVarName, pingsubsetString,
-  includePingRanges = TRUE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    acoVarName

    Acoustic variable name

    pingsubsetString

    A ping subset string (see examples).

    includePingRanges

    =TRUE Boolean. Default is for data within the ping range to be included

    - -

    Value

    +
    +

    Usage

    + 
    EVPingSubset(EVFile, acoVarName, pingsubsetString, includePingRanges = TRUE)
    +
    -

    a list object with two elements. $success: ping subset successfully changed, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    + + +
    acoVarName
    +

    Acoustic variable name

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    + +
    pingsubsetString
    +

    A ping subset string (see examples).

    + + +
    includePingRanges
    +

    =TRUE Boolean. Default is for data within the ping range to be included

    + +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj=COMCreate('EchoviewCom.EvApplication')
-EVOpenFile(EVAppObj,'~\\example1.EV')
-EVpingSubset(EVFile=EVFile,acoVarName='Ping subset 38',pingsubsetString='2-7')
+
    a list object with two elements.  $success: ping subset successfully changed, and $msg: message for processing log.
    
+
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    -# } -
    -
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVRegionClassFinder.html b/docs/reference/EVRegionClassFinder.html index 964a7f3..41d5857 100644 --- a/docs/reference/EVRegionClassFinder.html +++ b/docs/reference/EVRegionClassFinder.html @@ -1,191 +1,115 @@ - - - - - - - -Find an Echoview region class by name — EVRegionClassFinder • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Find an Echoview region class by name — EVRegionClassFinder • EchoviewR + Skip to contents + +
    -
    -
    -

    Find an Echoview region class by name

    - Source: R/EchoviewR.R - +
    +

    Find an Echoview region class by name

    + Source: R/EchoviewR.R +
    EVRegionClassFinder.Rd
    -
    - +

    This function finds an echoview region class by name.

    -
    - 
    EVRegionClassFinder(EVFile, regionClassName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    regionClassName

    A string containing the name of an Echoview region

    - -

    Value

    +
    +

    Usage

    + 
    EVRegionClassFinder(EVFile, regionClassName)
    +
    -

    a list object with two elements. $regionClass: The class of the region, and $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    regionClassName
    +

    A string containing the name of an Echoview region

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-aggregationsClass <- EVRegionClassFinder(EVFile, "aggregations")$regionClass
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with two elements. $regionClass: The class of the region, and $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+aggregationsClass <- EVRegionClassFinder(EVFile, "aggregations")$regionClass
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVRenameAcousticVar.html b/docs/reference/EVRenameAcousticVar.html index 7a3e83d..59cc046 100644 --- a/docs/reference/EVRenameAcousticVar.html +++ b/docs/reference/EVRenameAcousticVar.html @@ -1,181 +1,106 @@ - - - - - - - -Rename an Echoview acoustic variable — EVRenameAcousticVar • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Rename an Echoview acoustic variable — EVRenameAcousticVar • EchoviewR + Skip to contents + +
    -
    -
    -

    Rename an Echoview acoustic variable

    - Source: R/EVRenameAcousticVar.R - +
    +

    Rename an Echoview acoustic variable

    + Source: R/EVRenameAcousticVar.R +
    EVRenameAcousticVar.Rd
    -
    - +

    This function renames an existing acoustic variable

    -
    - 
    EVRenameAcousticVar(EVFile, acoVarName, newName)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    EVFile

    Echoview file COM object

    acoVarName

    The acoustic variable name to which a new variable will be added.

    newName

    New name of the acoustic variable

    - -

    Value

    +
    +

    Usage

    + 
    EVRenameAcousticVar(EVFile, acoVarName, newName)
    +
    -

    list with three elements: $varObj acoustic variable COM object; $objName new name of the variable object;$msg message vector

    - -

    Note

    +
    +

    Arguments

    +
    EVFile
    +

    Echoview file COM object

    -

    The function will check if the proposed new variable new already exists. If the porposed new name exists, then the new name will be chnaged to 'newName duplicate name'.

    + +
    acoVarName
    +

    The acoustic variable name to which a new variable will be added.

    + + +
    newName
    +

    New name of the acoustic variable

    + +
    +
    +

    Value

    -
    - +
    +

    Note

    +

    The function will check if the proposed new variable new already exists. If the porposed new name exists, then the new name will be chnaged to 'newName duplicate name'.

    +
    -
  • Note
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVRenameLine.html b/docs/reference/EVRenameLine.html index 6428684..8f9524a 100644 --- a/docs/reference/EVRenameLine.html +++ b/docs/reference/EVRenameLine.html @@ -1,197 +1,121 @@ - - - - - - - -Renames an Echoview Line object — EVRenameLine • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Renames an Echoview Line object — EVRenameLine • EchoviewR + Skip to contents + +
    -
    -
    -

    Renames an Echoview Line object

    - Source: R/EchoviewR.R - +
    +

    Renames an Echoview Line object

    + Source: R/EchoviewR.R +
    EVRenameLine.Rd
    -
    - +

    This function renames an Echoview line object using COM scripting

    -
    - 
    EVRenameLine(EVFile, evLine, newName)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    evLine

    an Echoview line object

    newName

    a string containing the new name for the line

    - -

    Value

    +
    +

    Usage

    + 
    EVRenameLine(EVFile, evLine, newName)
    +
    -

    a list object with one element- fucntion message for log

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile EVNewFixedDepthLine EVFindLineByName

    - +
    evLine
    +

    an Echoview line object

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
 
-testline <- EVNewFixedDepthLine(EVFile = EVFile, depth = 50, lineName = "testline")
-EVRenameLine(EVFile = EVFile, evLine = testline, newName = "line40")
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with one element- fucntion message for log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVNewFixedDepthLine EVFindLineByName

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+testline <- EVNewFixedDepthLine(EVFile = EVFile, depth = 50, lineName = "testline")
+EVRenameLine(EVFile = EVFile, evLine = testline, newName = "line40")
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVResampleByPingControl.html b/docs/reference/EVResampleByPingControl.html index ba666e9..6593d6f 100644 --- a/docs/reference/EVResampleByPingControl.html +++ b/docs/reference/EVResampleByPingControl.html @@ -1,193 +1,126 @@ - - - - - - +Control the 'Resample by ping' Echoview virtual variable settings using COM — EVResampleByPingControl • EchoviewR + Skip to contents + -Control the 'Resample by ping' Echoview virtual variable settings using COM — EVResampleByPingControl • EchoviewR +
    +
    +
    +

    Control the 'Resample by ping' Echoview virtual variable settings using COM

    + Source: R/EVResampleByPingControl.R +
    EVResampleByPingControl.Rd
    +
    - - - +
    +

    This function controls the 'Resample by ping' Echoview virtual variable settings using COM

    +
    +
    +

    Usage

    + 
    EVResampleByPingControl(
+  EVFile,
+  acoVarName,
+  NumberOfSamples = NULL,
+  NumberOfPings = NULL,
+  StartRange = NULL,
+  StopRange = NULL,
+  verbose = FALSE
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    Echoview file COM object

    - - - +
    acoVarName
    +

    name of the 'Resample by pings' acoustic variable

    +
    NumberOfSamples
    +

    number of samples to export in the depth dimension.

    - - - - - - - - -
    -
    - - -
    +
    StartRange
    +

    start range, m

    -
    -
    -
    -

    Control the 'Resample by ping' Echoview virtual variable settings using COM

    - Source: R/EVResampleByPingControl.R - -
    -
    - -

    This function controls the 'Resample by ping' Echoview virtual variable settings using COM

    - -
    +
    StopRange
    +

    maximum range, m

    - 
    EVResampleByPingControl(EVFile, acoVarName, NumberOfSamples = NULL,
-  NumberOfPings = NULL, StartRange = NULL, StopRange = NULL,
-  verbose = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    Echoview file COM object

    acoVarName

    name of the 'Resample by pings' acoustic variable

    NumberOfSamples

    number of samples to export in the depth dimension.

    NumberOfPings

    number of pings to resample

    StartRange

    start range, m

    StopRange

    maximum range, m

    verbose

    = FALSE

    - -

    Value

    -

    List of length three [1] $previousSettings [2] $currentSettings [3] message vector

    +
    verbose
    +

    = FALSE

    + +
    +
    +

    Value

    -
    - + +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVSTWideband.html b/docs/reference/EVSTWideband.html index 11ba612..9b1e909 100644 --- a/docs/reference/EVSTWideband.html +++ b/docs/reference/EVSTWideband.html @@ -1,220 +1,158 @@ - - - - - - +Broadband Single target detection — EVSTWideband • EchoviewR + Skip to contents + -Broadband Single target detection — EVSTWideband • EchoviewR +
    +
    +
    +

    Broadband Single target detection

    + Source: R/EVSTWideband.R +
    EVSTWideband.Rd
    +
    - - - +
    +

    This function creates a Wideband Single Target Detection Variable

    +
    +
    +

    Usage

    + 
    EVSTWideband(
+  EVFile,
+  EVVar,
+  Operand2,
+  TsThreshold = NULL,
+  MinimumPulseLength = NULL,
+  MaximumPulseLength = NULL,
+  BeamCompensationModel = NULL,
+  MaximumBeamCompensation = NULL,
+  MaximumStdDevOfMajorAxisAngles = NULL,
+  MaximumStdDevOfMinorAxisAngles = NULL
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    - - - +
    EVVar
    +

    An Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    +
    Operand2
    +

    An Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    - - - - - - - - -
    -
    - - -
    +
    MinimumPulseLength
    +

    numeric Minimum normalized pulse length

    -
    -
    -
    -

    Broadband Single target detection

    - Source: R/EVSTWideband.R - -
    -
    - -

    This function creates a Wideband Single Target Detection Variable

    - -
    +
    MaximumPulseLength
    +

    numeric Maximum normalized pulse length ,

    - 
    EVSTWideband(EVFile, EVVar, Operand2, TsThreshold = NULL,
-  MinimumPulseLength = NULL, MaximumPulseLength = NULL,
-  BeamCompensationModel = NULL, MaximumBeamCompensation = NULL,
-  MaximumStdDevOfMajorAxisAngles = NULL,
-  MaximumStdDevOfMinorAxisAngles = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    EVVar

    An Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    Operand2

    An Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)

    TsThreshold

    numeric [dB] Single target detection threshold

    MinimumPulseLength

    numeric Minimum normalized pulse length

    MaximumPulseLength

    numeric Maximum normalized pulse length ,

    BeamCompensationModel

    numeric [1,4] 1 = Simrad Lobe, 4 = None,

    MaximumBeamCompensation

    NULL=,numeric Maximum beam compensationngles = NULL,

    MaximumStdDevOfMajorAxisAngles

    Maximum standard deviation of major axis angles

    MaximumStdDevOfMinorAxisAngles

    Maximum standard deviation of minor axis angles

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - +
    BeamCompensationModel
    +

    numeric [1,4] 1 = Simrad Lobe, 4 = None,

    -

    Examples

    - 
    #To be added - Needs Example data
-#Starting Echoview
-echoview = StartEchoview()
    #> 2018-11-01 10:54:57: Opening Echoview
    #> Warning: Couldn't get clsid from the string
    #> Error: Invalid class string
    #Create a new EV File
-EVFile <- EVCreateNew(EVAppObj=echoview, dataFiles = "rawfile.raw")$EVFile
    #> 2018-11-01 10:54:57 : Creating new EV file
    #> Error in EVNewFile(EVAppObj = EVAppObj, templateFn = templateFn): object 'echoview' not found
    #Set the First and second Operand
-EVVar <- "Fileset 1: TS pulse compressed wideband pings T1"
-Operand2 <- "Fileset 1: angular position pulse compressed wideband pings T1"
-#Create a wideband single target detection varable
-ST <- EVSTWideband(EVFile=EVFile,EVVar=EVVar,Operand2=Operand2)
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
    # Change TS detection threshold
-ST <- EVSTWideband(EVFile=EVFile,EVVar=EVVar,Operand2=Operand2,TsThreshold=-90)
    #> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
    
-
    -
    - -
    +
    MaximumBeamCompensation
    +

    NULL=,numeric Maximum beam compensationngles = NULL,

    + + +
    MaximumStdDevOfMajorAxisAngles
    +

    Maximum standard deviation of major axis angles

    -
    -
    + +
    MaximumStdDevOfMinorAxisAngles
    +

    Maximum standard deviation of minor axis angles

    + +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    + +
    +

    Examples

    + 
    #To be added - Needs Example data
+if (FALSE) {
+#Starting Echoview
+echoview = StartEchoview()
+#Create a new EV File
+EVFile <- EVCreateNew(EVAppObj=echoview, dataFiles = "rawfile.raw")$EVFile
+#Set the First and second Operand
+EVVar <- "Fileset 1: TS pulse compressed wideband pings T1"
+Operand2 <- "Fileset 1: angular position pulse compressed wideband pings T1"
+#Create a wideband single target detection varable
+ST <- EVSTWideband(EVFile=EVFile,EVVar=EVVar,Operand2=Operand2)
+# Change TS detection threshold
+ST <- EVSTWideband(EVFile=EVFile,EVVar=EVVar,Operand2=Operand2,TsThreshold=-90)
+}
+
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVSaveAsFile.html b/docs/reference/EVSaveAsFile.html index cd5fd92..a0a3968 100644 --- a/docs/reference/EVSaveAsFile.html +++ b/docs/reference/EVSaveAsFile.html @@ -1,191 +1,115 @@ - - - - - - - -Perform save as operation on an open Echoview file (.EV) — EVSaveAsFile • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Perform save as operation on an open Echoview file (.EV) — EVSaveAsFile • EchoviewR + Skip to contents + +
    -
    -
    -

    Perform save as operation on an open Echoview file (.EV)

    - Source: R/EchoviewR.R - +
    +

    Perform save as operation on an open Echoview file (.EV)

    + Source: R/EchoviewR.R +
    EVSaveAsFile.Rd
    -
    - +

    This function performs a save as operation on an existing Echoview (.EV) file using COM scripting.

    -
    - 
    EVSaveAsFile(EVFile, fileName)
    - -

    Arguments

    - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    fileName

    An Echoview file path and name.

    - -

    Value

    +
    +

    Usage

    + 
    EVSaveAsFile(EVFile, fileName)
    +
    -

    a list object with two elements. $chk: Boolean check indicating if the file was successfully saved; $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVSaveFile EVCloseFile

    - +
    fileName
    +

    An Echoview file path and name.

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVSaveAsFile(EVFile = EVFile, fileName = '~~/KAOS/KAOStemplate_test.EV')
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with two elements. $chk: Boolean check indicating if the file was successfully saved; $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVSaveFile EVCloseFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVSaveAsFile(EVFile = EVFile, fileName = '~~/KAOS/KAOStemplate_test.EV')
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVSaveFile.html b/docs/reference/EVSaveFile.html index 52ba688..324d6ec 100644 --- a/docs/reference/EVSaveFile.html +++ b/docs/reference/EVSaveFile.html @@ -1,187 +1,111 @@ - - - - - - - -Save an open Echoview file (.EV) — EVSaveFile • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Save an open Echoview file (.EV) — EVSaveFile • EchoviewR + Skip to contents + +
    -
    -
    -

    Save an open Echoview file (.EV)

    - Source: R/EchoviewR.R - +
    +

    Save an open Echoview file (.EV)

    + Source: R/EchoviewR.R +
    EVSaveFile.Rd
    -
    - +

    This function saves an existing Echoview (.EV) file using COM scripting.

    -
    - 
    EVSaveFile(EVFile)
    - -

    Arguments

    - - - - - - -
    EVFile

    An Echoview file COM object

    - -

    Value

    - -

    a list object with two elements. $chk: Boolean check indicating if the file was successfully saved; $msg: message for processing log.

    - -

    References

    +
    +

    Usage

    + 
    EVSaveFile(EVFile)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    EVOpenFile

    +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVSaveFile(EVFile)
-# }
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVSaveFile(EVFile)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVSchoolsDetSet.html b/docs/reference/EVSchoolsDetSet.html index 8a07833..b3731c1 100644 --- a/docs/reference/EVSchoolsDetSet.html +++ b/docs/reference/EVSchoolsDetSet.html @@ -1,228 +1,160 @@ - - - - - - +Change schools detection settings — EVSchoolsDetSet • EchoviewR + Skip to contents + -Change schools detection settings — EVSchoolsDetSet • EchoviewR +
    +
    +
    +

    Change schools detection settings

    + Source: R/EchoviewR.R +
    EVSchoolsDetSet.Rd
    +
    - - - +
    +

    This function changes schools detection settings for an acoustic variable using COM scripting

    +
    +
    +

    Usage

    + 
    EVSchoolsDetSet(
+  EVFile,
+  varObj,
+  distanceMode,
+  maximumHorizontalLink,
+  maximumVerticalLink,
+  minimumCandidateHeight,
+  minimumCandidateLength,
+  minimumSchoolHeight,
+  minimumSchoolLength
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    - - - +
    varObj
    +

    the EV acoustic object to change schools detection parameters for

    +
    distanceMode
    +

    which distance mode to use

    - - - - - - - - -
    -
    - - -
    +
    maximumVerticalLink
    +

    maximum vertical linking distance for a school

    -
    -
    -
    -

    Change schools detection settings

    - Source: R/EchoviewR.R - -
    -
    - -

    This function changes schools detection settings for an acoustic variable using COM scripting

    - -
    +
    minimumCandidateHeight
    +

    minimum candidate height

    - 
    EVSchoolsDetSet(EVFile, varObj, distanceMode, maximumHorizontalLink,
-  maximumVerticalLink, minimumCandidateHeight, minimumCandidateLength,
-  minimumSchoolHeight, minimumSchoolLength)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    varObj

    the EV acoustic object to change schools detection parameters for

    distanceMode

    which distance mode to use

    maximumHorizontalLink

    maximum linking distance for a swarm

    maximumVerticalLink

    maximum vertical linking distance for a school

    minimumCandidateHeight

    minimum candidate height

    minimumCandidateLength

    minimum candidate length

    minimumSchoolHeight

    minimum school height

    minimumSchoolLength

    minimum school length

    - -

    Value

    -

    a list object with two elements.

    - -

    References

    +
    minimumCandidateLength
    +

    minimum candidate length

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile EVAcoVarNameFinder

    - +
    minimumSchoolHeight
    +

    minimum school height

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-varObj <- EVAcoVarNameFinder(EVFile, "120 7x7 convolution")$EVVar
-changeSettings <- EVSchoolsDetSet(EVFile, varObj, distanceMode = "GPS distance",
-                                maximumHorizontalLink = 10,
-                                maximumVerticalLink = 5,
-                                minimumCandidateHeight = 2,
-                                minimumCandidateLength = 3,
-                                minimumSchoolHeight = 4,
-                                minimumSchoolLength = 2)
-# }
    -
    -
    +
    +

    Value

    + -
    -
    +

    a list object with two elements.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVAcoVarNameFinder

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+varObj <- EVAcoVarNameFinder(EVFile, "120 7x7 convolution")$EVVar
+changeSettings <- EVSchoolsDetSet(EVFile, varObj, distanceMode = "GPS distance",
+                                maximumHorizontalLink = 10,
+                                maximumVerticalLink = 5,
+                                minimumCandidateHeight = 2,
+                                minimumCandidateLength = 3,
+                                minimumSchoolHeight = 4,
+                                minimumSchoolLength = 2)
+}
+
    +
    + -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVSchoolsDetect.html b/docs/reference/EVSchoolsDetect.html index 691405a..39cc3a9 100644 --- a/docs/reference/EVSchoolsDetect.html +++ b/docs/reference/EVSchoolsDetect.html @@ -1,245 +1,184 @@ - - - - - - +Schools Detection in Echoview — EVSchoolsDetect • EchoviewR + Skip to contents + -Schools Detection in Echoview — EVSchoolsDetect • EchoviewR +
    +
    +
    +

    Schools Detection in Echoview

    + Source: R/EVSchoolsDetect.R +
    EVSchoolsDetect.Rd
    +
    - - - +
    +

    This function performs schools detection in Echoview using COM scripting.

    +
    +
    +

    Usage

    + 
    EVSchoolsDetect(
+  EVApp = NULL,
+  EVFile = NULL,
+  acoVarName,
+  outputRegionClassName,
+  deleteExistingRegions,
+  distanceMode,
+  maximumHorizontalLink,
+  maximumVerticalLink,
+  minimumCandidateHeight,
+  minimumCandidateLength,
+  minimumSchoolHeight,
+  minimumSchoolLength,
+  dataThreshold
+)
    +
    +
    +

    Arguments

    +
    EVApp
    +

    =NULL An Echoview Application COM object

    - - - +
    EVFile
    +

    =NULL An Echoview file COM object

    +
    acoVarName
    +

    A string containing the name of the acoustic variable to perform the analysis on

    - - - - - - - - -
    -
    - - -
    +
    deleteExistingRegions
    +

    Logical TRUE or FALSE

    -
    -
    -
    -

    Schools Detection in Echoview

    - Source: R/EchoviewR.R - -
    -
    - -

    This function performs schools detection in Echoview using COM scripting.

    - -
    +
    distanceMode
    +

    for schools detection (see Echoview help).

    - 
    EVSchoolsDetect(EVFile, acoVarName, outputRegionClassName,
-  deleteExistingRegions, distanceMode, maximumHorizontalLink,
-  maximumVerticalLink, minimumCandidateHeight, minimumCandidateLength,
-  minimumSchoolHeight, minimumSchoolLength, dataThreshold)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    acoVarName

    A string containing the name of the acoustic variable to perform the analysis on

    outputRegionClassName

    A string containing the name of the output region

    deleteExistingRegions

    Logical TRUE or FALSE

    distanceMode

    for schools detection (see Echoview help).

    maximumHorizontalLink

    The maximum horizontal link in meters

    maximumVerticalLink

    The maximum vertical link in meters

    minimumCandidateHeight

    The minimum candidate height in meters

    minimumCandidateLength

    the minimum candidate length in meters

    minimumSchoolHeight

    The minimum school height in meters

    minimumSchoolLength

    The minimum school length in meters

    dataThreshold

    minimum integration threshold (units: dB re 1m^-1)

    - -

    Value

    -

    a list object with four elements. $nbrOfDetectedschools, $thresholdData, $schoolsSettingsData, and $msg: message for processing log

    - -

    References

    +
    maximumHorizontalLink
    +

    The maximum horizontal link in meters

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    maximumVerticalLink
    +

    The maximum vertical link in meters

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-EVSchoolsDetect(EVFile = EVFile,
-               acoVarName='120 7x7 convolution',
-               outputRegionClassName = 'aggregations',
-               deleteExistingRegions = TRUE,
-               distanceMode = "GPS distance",
-               maximumHorizontalLink = 15, #m
-               maximumVerticalLink = 5,#m
-               minimumCandidateHeight = 1, #m
-               minimumCandidateLength = 10, #m
-               minimumSchoolHeight = 2, #m
-               minimumSchoolLength = 15, #m
-               dataThreshold = -80)
-# }
    -
    - -
    +
    minimumCandidateLength
    +

    the minimum candidate length in meters

    + + +
    minimumSchoolHeight
    +

    The minimum school height in meters

    -
    -
    + +
    minimumSchoolLength
    +

    The minimum school length in meters

    + + +
    dataThreshold
    +

    minimum integration threshold (units: dB re 1m^-1)

    + +
    +
    +

    Value

    + + +

    a list object with four elements. $nbrOfDetectedschools, $thresholdData, $schoolsSettingsData, and $msg: message for processing log

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+EVSchoolsDetect(EVFile = EVFile,
+               acoVarName='120 7x7 convolution',
+               outputRegionClassName = 'aggregations',
+               deleteExistingRegions = TRUE,
+               distanceMode = "GPS distance",
+               maximumHorizontalLink = 15, #m
+               maximumVerticalLink = 5,#m
+               minimumCandidateHeight = 1, #m
+               minimumCandidateLength = 10, #m
+               minimumSchoolHeight = 2, #m
+               minimumSchoolLength = 15, #m
+               dataThreshold = -80)
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    + + + - - + diff --git a/docs/reference/EVSetAcoVarDisplayDepth.html b/docs/reference/EVSetAcoVarDisplayDepth.html index 3c03477..8444964 100644 --- a/docs/reference/EVSetAcoVarDisplayDepth.html +++ b/docs/reference/EVSetAcoVarDisplayDepth.html @@ -1,194 +1,118 @@ - - - - - - - -Set the minimum and maximum display depth for an acoustic variable. — EVSetAcoVarDisplayDepth • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Set the minimum and maximum display depth for an acoustic variable. — EVSetAcoVarDisplayDepth • EchoviewR + Skip to contents + +
    -
    -
    -

    Set the minimum and maximum display depth for an acoustic variable.

    - Source: R/EVSetAcoVarDisplayDepth.R - +
    +

    Set the minimum and maximum display depth for an acoustic variable.

    + Source: R/EVSetAcoVarDisplayDepth.R +
    EVSetAcoVarDisplayDepth.Rd
    -
    - +

    This function changes the maximum and minimum depth displayed in the Echogram for an acoustic variable using COM scripting.

    -
    - 
    EVSetAcoVarDisplayDepth(EVFile, acoVarName, minDepth, maxDepth)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    acoVarName

    Name of acoustic variable

    minDepth

    The minimum depth to display in metres

    maxDepth

    The maximum depth to display in meters

    - -

    References

    +
    +

    Usage

    + 
    EVSetAcoVarDisplayDepth(EVFile, acoVarName, minDepth, maxDepth)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    EVAcoVarNameFinder

    - -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj, 'KAOS/KAOStemplate.EV')$EVFile
-EVSetAcoVarDisplayDepth(EVFile, "38 seabed and surface excluded", 5, 250)
-# }
    
-
    -
    - -
    -
    -
    +
    minDepth
    +

    The minimum depth to display in metres

    + + +
    maxDepth
    +

    The maximum depth to display in meters

    + +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVAcoVarNameFinder

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj, 'KAOS/KAOStemplate.EV')$EVFile
+EVSetAcoVarDisplayDepth(EVFile, "38 seabed and surface excluded", 5, 250)
+}
+
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVShiftRegionDepth.html b/docs/reference/EVShiftRegionDepth.html index b651ca5..44b0a1f 100644 --- a/docs/reference/EVShiftRegionDepth.html +++ b/docs/reference/EVShiftRegionDepth.html @@ -1,207 +1,131 @@ - - - - - - - -Change the depth of an Echoview Region — EVShiftRegionDepth • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Change the depth of an Echoview Region — EVShiftRegionDepth • EchoviewR + Skip to contents + +
    -
    -
    -

    Change the depth of an Echoview Region

    - Source: R/EchoviewR.R - +
    +

    Change the depth of an Echoview Region

    + Source: R/EchoviewR.R +
    EVShiftRegionDepth.Rd
    -
    - +

    This function shifts the depth of an echoview region using COM scripting. Vertical size of the region and depth offset can be changed.

    -
    - 
    EVShiftRegionDepth(EVFile, regionName, depthMultiply, depthAdd)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    regionName

    a string containing the name of the Echoview region

    depthMultiply

    a numeric value to multiply the vertical size of the region by

    depthAdd

    a numeric value to offset the region depth by. Positive = decrease depth; Negative = increase depth

    - -

    Value

    +
    +

    Usage

    + 
    EVShiftRegionDepth(EVFile, regionName, depthMultiply, depthAdd)
    +
    -

    a list object with one element, $msg: message for processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile

    - +
    regionName
    +

    a string containing the name of the Echoview region

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
 
-#Double region vertical size and decrease depth by 100m
-EVShiftRegionDepth(EVFile, "testregion", 2, 100)
+
    depthMultiply
    
+
    a numeric value to multiply the vertical size of the region by
    
 
-#Triple region vertical size without changing depth offset
-EVShiftRegionDepth(EVFile, "testregion", 3, 0)
 
-#Change region depth offset by -50m without changing vertical size
-EVShiftRegionDepth(EVFile, "testregion", 1, -50)
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with one element, $msg: message for processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+#Double region vertical size and decrease depth by 100m
+EVShiftRegionDepth(EVFile, "testregion", 2, 100)
+
+#Triple region vertical size without changing depth offset
+EVShiftRegionDepth(EVFile, "testregion", 3, 0)
+
+#Change region depth offset by -50m without changing vertical size
+EVShiftRegionDepth(EVFile, "testregion", 1, -50)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVShiftRegionTime.html b/docs/reference/EVShiftRegionTime.html index 0a2a448..85957d5 100644 --- a/docs/reference/EVShiftRegionTime.html +++ b/docs/reference/EVShiftRegionTime.html @@ -1,217 +1,148 @@ - - - - - - - -Change the time of an Echoview Region — EVShiftRegionTime • EchoviewR +Change the time of an Echoview Region — EVShiftRegionTime • EchoviewR + Skip to contents + - - - +
    +
    +
    +

    Change the time of an Echoview Region

    + Source: R/EchoviewR.R +
    EVShiftRegionTime.Rd
    +
    +
    +

    This function shifts the time of an echoview region using COM scripting

    +
    +
    +

    Usage

    + 
    EVShiftRegionTime(
+  EVFile,
+  regionName,
+  days = 0,
+  hours = 0,
+  minutes = 0,
+  seconds = 0,
+  milliseconds = 0
+)
    +
    - +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    - - +
    regionName
    +

    a string containing the name of the Echoview region

    - - +
    days
    +

    an integer value specifying days to add (positive) or subtract (negative). Default = 0

    - - - - - - -
    -
    - +
    hours
    +

    an integer value specifying hours to add (positive) or subtract (negative). Default = 0

    - -
    -
    -
    -
    -

    Change the time of an Echoview Region

    - Source: R/EchoviewR.R - -
    +
    minutes
    +

    an integer value specifying minutes to add (positive) or subtract (negative). Default = 0

    -
    - -

    This function shifts the time of an echoview region using COM scripting

    - -
    - 
    EVShiftRegionTime(EVFile, regionName, days = 0, hours = 0,
-  minutes = 0, seconds = 0, milliseconds = 0)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    regionName

    a string containing the name of the Echoview region

    days

    an integer value specifying days to add (positive) or subtract (negative). Default = 0

    hours

    an integer value specifying hours to add (positive) or subtract (negative). Default = 0

    minutes

    an integer value specifying minutes to add (positive) or subtract (negative). Default = 0

    seconds

    an integer value specifying seconds to add (positive) or subtract (negative). Default = 0

    milliseconds

    an integer value specifying milliseconds to add (positive) or subtract (negative). Default = 0

    - -

    Value

    +
    seconds
    +

    an integer value specifying seconds to add (positive) or subtract (negative). Default = 0

    -

    a list object with one element, $msg: message for processing log.

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    milliseconds
    +

    an integer value specifying milliseconds to add (positive) or subtract (negative). Default = 0

    -

    EVOpenFile

    +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-
-#Shift the region time by 10 seconds
-EVShiftRegionTime(EVFile, "testregion", seconds = 10)
-
-#Subtract 1 hour from the region time
-EVShiftRegionTime(EVFile, "testregion", hours = -1)
-# }
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+
+#Shift the region time by 10 seconds
+EVShiftRegionTime(EVFile, "testregion", seconds = 10)
+
+#Subtract 1 hour from the region time
+EVShiftRegionTime(EVFile, "testregion", hours = -1)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVVersion.html b/docs/reference/EVVersion.html index b6f842d..dafe8a7 100644 --- a/docs/reference/EVVersion.html +++ b/docs/reference/EVVersion.html @@ -1,175 +1,105 @@ - - - - - - - -Get the current version of Echoview — EVVersion • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Get the current version of Echoview — EVVersion • EchoviewR + Skip to contents + +
    -
    -
    -

    Get the current version of Echoview

    - Source: R/EVVersion.R - +
    +

    Get the current version of Echoview

    + Source: R/EVVersion.R +
    EVVersion.Rd
    -
    - +

    This function returns the version of Echoview that was started through EchoviewR

    -
    - 
    EVVersion(EVApp = NULL)
    - -

    Arguments

    - - - - - - -
    EVApp

    An Echoview Application object

    - -

    References

    +
    +

    Usage

    + 
    EVVersion(EVApp = NULL)
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - +
    +

    Arguments

    +
    EVApp
    +

    An Echoview Application object

    -

    Examples

    - 
    #Create an Echoview application object and start Echoview
-EVApp <- StartEchoview()
    #> 2018-11-01 10:54:57: Opening Echoview
    #> Warning: Couldn't get clsid from the string
    #> Error: Invalid class string
    #get the current version of the Echoview App started through EchoviewR
-EVVersion(EVApp)
    #> Error in EVVersion(EVApp): object 'EVApp' not found
    #Quit the application again
-QuitEchoview(EVApp)
    #> 2018-11-01 10:54:57: Closing Echoview
    #> Error in QuitEchoview(EVApp): object 'EVApp' not found
    
-
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+#Create an Echoview application object and start Echoview
+EVApp <- StartEchoview()
+#get the current version of the Echoview App started through EchoviewR
+EVVersion(EVApp)
+#Quit the application again
+QuitEchoview(EVApp)
+}
+
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVmaxThresholdSet.html b/docs/reference/EVmaxThresholdSet.html index 5ad7a3e..11303dc 100644 --- a/docs/reference/EVmaxThresholdSet.html +++ b/docs/reference/EVmaxThresholdSet.html @@ -1,200 +1,124 @@ - - - - - - - -Sets maximum data threshold for a variable object — EVmaxThresholdSet • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Sets maximum data threshold for a variable object — EVmaxThresholdSet • EchoviewR + Skip to contents + +
    -
    -
    -

    Sets maximum data threshold for a variable object

    - Source: R/EVmaxThresholdSet.R - +
    +

    Sets maximum data threshold for a variable object

    + Source: R/EVmaxThresholdSet.R +
    EVmaxThresholdSet.Rd
    -
    - +

    This function sets the maxmimum data threshold

    -
    - 
    EVmaxThresholdSet(EVFile, acoVarName, thres, colRng = 36)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    acoVarName

    (character) Echoview acoustic variable name

    thres

    The new maximum threshold to be set (dB)

    colRng

    maximum colour range possible for display settings. Set to NA if you want any colour range.

    - -

    Value

    +
    +

    Usage

    + 
    EVmaxThresholdSet(EVFile, acoVarName, thres, colRng = 36)
    +
    -

    a list object with two elements. $thresholdSettings: The new threshold settings; $msg vector of messages

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile EVminThresholdSet

    - +
    acoVarName
    +

    (character) Echoview acoustic variable name

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-varObj <- EVAcoVarNameFinder(EVFile, "38 seabed and surface excluded")$EVVar
-EVmaxThresholdSet(varObj, -30)
-# }
    -
    - -
    +
    colRng
    +

    maximum colour range possible for display settings. Set to NA if you want any colour range.

    + +
    +
    +

    Value

    + -
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVminThresholdSet.html b/docs/reference/EVminThresholdSet.html index a6bf6d8..9e5ef06 100644 --- a/docs/reference/EVminThresholdSet.html +++ b/docs/reference/EVminThresholdSet.html @@ -1,192 +1,116 @@ - - - - - - - -Sets minimum data threshold for a variable object — EVminThresholdSet • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Sets minimum data threshold for a variable object — EVminThresholdSet • EchoviewR + Skip to contents + +
    -
    -
    -

    Sets minimum data threshold for a variable object

    - Source: R/EchoviewR.R - +
    +

    Sets minimum data threshold for a variable object

    + Source: R/EchoviewR.R +
    EVminThresholdSet.Rd
    -
    - +

    This function sets the minimum data threshold

    -
    - 
    EVminThresholdSet(varObj, thres)
    - -

    Arguments

    - - - - - - - - - - -
    varObj

    An Echoview variable object

    thres

    The new threshold to be set

    - -

    Value

    +
    +

    Usage

    + 
    EVminThresholdSet(varObj, thres)
    +
    -

    a list object with one element. $thresholdSettings: The new threshold settings

    - -

    References

    +
    +

    Arguments

    +
    varObj
    +

    An Echoview variable object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVOpenFile EVAcoVarNameFinder

    - +
    thres
    +

    The new threshold to be set

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj <- COMCreate('EchoviewCom.EvApplication')
-EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
-varObj <- EVAcoVarNameFinder(EVFile, "38 seabed and surface excluded")$EVVar
-EVminThresholdSet(varObj, -80)
-# }
    -
    - +
    +

    Value

    + -
  • References
    • +

    a list object with one element. $thresholdSettings: The new threshold settings

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVOpenFile EVAcoVarNameFinder

    +
    -
  • See also
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj <- COMCreate('EchoviewCom.EvApplication')
+EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
+varObj <- EVAcoVarNameFinder(EVFile, "38 seabed and surface excluded")$EVVar
+EVminThresholdSet(varObj, -80)
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVsetExclusionLines.html b/docs/reference/EVsetExclusionLines.html index 1523f01..8752502 100644 --- a/docs/reference/EVsetExclusionLines.html +++ b/docs/reference/EVsetExclusionLines.html @@ -1,196 +1,123 @@ - - - - - - - -Change the top and bottom exclusion lines in an Echoview acoustic variable — EVsetExclusionLines • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Change the top and bottom exclusion lines in an Echoview acoustic variable — EVsetExclusionLines • EchoviewR + Skip to contents + +
    -
    -
    -

    Change the top and bottom exclusion lines in an Echoview acoustic variable

    - Source: R/EVsetExclusionLines.R - +
    +

    Change the top and bottom exclusion lines in an Echoview acoustic variable

    + Source: R/EVsetExclusionLines.R +
    EVsetExclusionLines.Rd
    -
    - +

    This function changes the top and bottom exclusion lines in an Echoview acoustic variable using COM scripting.

    -
    - 
    EVsetExclusionLines(EVFile, acoVarName, newAboveExclusionLine = NULL,
-  newBelowExclusionLine = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    EVFile

    An Echoview file COM object

    acoVarName

    Acoustic variable name.

    newAboveExclusionLine

    Name of the top exclusion line to be used. Default is NULL in which case the top exclusion line is unchanged.

    newBelowExclusionLine

    Name of the bottom exclusion line to be used. Default is NULL in which case the bottom exclusion line is unchanged.

    - -

    Value

    +
    +

    Usage

    + 
    EVsetExclusionLines(
+  EVFile,
+  acoVarName,
+  newAboveExclusionLine = NULL,
+  newBelowExclusionLine = NULL
+)
    +
    -

    a list object with two elements. $analysisProperties: The analysis properties COM object specified in acoVarName, and $msg: message vector for the processing log.

    - -

    References

    +
    +

    Arguments

    +
    EVFile
    +

    An Echoview file COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    -

    EVAcoVarNameFinder

    - +
    acoVarName
    +

    Acoustic variable name.

    -
    - +
    +

    Value

    -Martin Cox -
    -
    +

    a list object with two elements. $analysisProperties: The analysis properties COM object specified in acoVarName, and $msg: message vector for the processing log.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVAcoVarNameFinder

    +
    +
    +

    Author

    +

    Martin Cox

    +
    + +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVsingleTargetPars.html b/docs/reference/EVsingleTargetPars.html index 82f1177..22b00e9 100644 --- a/docs/reference/EVsingleTargetPars.html +++ b/docs/reference/EVsingleTargetPars.html @@ -1,214 +1,144 @@ - - - - - - +Change the single target settings for Echoview single target virtual variable — EVsingleTargetPars • EchoviewR + Skip to contents + -Change the single target settings for Echoview single target virtual variable — EVsingleTargetPars • EchoviewR +
    +
    +
    +

    Change the single target settings for Echoview single target virtual variable

    + Source: R/EVsingleTargetPars.R +
    EVsingleTargetPars.Rd
    +
    - - - +
    +

    Change the single target settings for Echoview virtual variable

    +
    +
    +

    Usage

    + 
    EVsingleTargetPars(
+  EVFile,
+  acoVarName,
+  ExcludeAboveLine = NULL,
+  ExcludeBelowLine = NULL,
+  MinimumPulseLength = NULL,
+  MaximumPulseLength = NULL,
+  PLDL = NULL,
+  TsThreshold = NULL,
+  verbose = FALSE
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    ("COMIDispatch) An Echoview file COM object

    - - - +
    acoVarName
    +

    (character) Name of Echoview single target virtual variable

    +
    ExcludeAboveLine
    +

    (character) Shallower exclusion line

    - - - - - - - - -
    -
    - - -
    +
    MinimumPulseLength
    +

    (numeric) Minimum pulse length

    -
    -
    -
    -

    Change the single target settings for Echoview single target virtual variable

    - Source: R/EVsingleTargetPars.R - -
    -
    - -

    Change the single target settings for Echoview virtual variable

    - -
    +
    MaximumPulseLength
    +

    (numeric) Maximum pulse length

    - 
    EVsingleTargetPars(EVFile, acoVarName, ExcludeAboveLine = NULL,
-  ExcludeBelowLine = NULL, MinimumPulseLength = NULL,
-  MaximumPulseLength = NULL, PLDL = NULL, TsThreshold = NULL,
-  verbose = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    ("COMIDispatch) An Echoview file COM object

    acoVarName

    (character) Name of Echoview single target virtual variable

    ExcludeAboveLine

    (character) Shallower exclusion line

    ExcludeBelowLine

    (character) Deeper exclusion line

    MinimumPulseLength

    (numeric) Minimum pulse length

    MaximumPulseLength

    (numeric) Maximum pulse length

    PLDL

    (numeric) Pulse length determination level

    TsThreshold

    (numeric) minimum target strength threshold (dB)

    verbose

    = FALSE (boolean)

    - -

    Value

    -

    list $settings 2 column data frame of pre-change post-change parameter values, $msg= vector of messages

    - -

    Details

    +
    PLDL
    +

    (numeric) Pulse length determination level

    -

    This function will work with single target detection viritual variables

    - -

    Note

    -

    THis function has only been tested using Simrad EK60 split-beam data

    - +
    TsThreshold
    +

    (numeric) minimum target strength threshold (dB)

    -
    -
    +
    +

    Value

    + -
    -
    +

    list $settings 2 column data frame of pre-change post-change parameter values, $msg= vector of messages

    +
    +
    +

    Details

    +

    This function will work with single target detection viritual variables

    +
    +
    +

    Note

    +

    THis function has only been tested using Simrad EK60 split-beam data

    +
    + +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/EVsplitBeamSingleTargetPars.html b/docs/reference/EVsplitBeamSingleTargetPars.html index 792a9e2..5a28e5b 100644 --- a/docs/reference/EVsplitBeamSingleTargetPars.html +++ b/docs/reference/EVsplitBeamSingleTargetPars.html @@ -1,206 +1,134 @@ - - - - - - +Change the SPLIT-BEAM single target settings for an Echoview split-beam single target virtual variable — EVsplitBeamSingleTargetPars • EchoviewR + Skip to contents + -Change the SPLIT-BEAM single target settings for an Echoview split-beam single target virtual variable — EVsplitBeamSingleTargetPars • EchoviewR +
    +
    +
    +

    Change the SPLIT-BEAM single target settings for an Echoview split-beam single target virtual variable

    + Source: R/EVsplitBeamSingleTargetPars.R +
    EVsplitBeamSingleTargetPars.Rd
    +
    - - - +
    +

    Change the split-beam single target settings for Echoview virtual variable of type split beam (method 1) and split-eabm (method 2)/

    +
    +
    +

    Usage

    + 
    EVsplitBeamSingleTargetPars(
+  EVFile,
+  acoVarName,
+  BeamCompensationModel = "SimradLobe",
+  MaximumBeamCompensation = NULL,
+  MaximumStdDevOfMajorAxisAngles = NULL,
+  MaximumStdDevOfMinorAxisAngles = NULL,
+  verbose = FALSE
+)
    +
    +
    +

    Arguments

    +
    EVFile
    +

    ("COMIDispatch) An Echoview file COM object

    - - - +
    acoVarName
    +

    (character) Name of Echoview single target virtual variable

    +
    BeamCompensationModel
    +

    ='SimradLOBE' c('Simrad LOBE','BioSonics','HTI','Furuno','Sonic')Beam compensation model

    - - - - - - - - -
    -
    - - -
    +
    MaximumStdDevOfMajorAxisAngles
    +

    =NULL (numeric) maximum standard deviation of Major axis angles (degrees)

    -
    -
    -
    -

    Change the SPLIT-BEAM single target settings for an Echoview split-beam single target virtual variable

    - Source: R/EVsplitBeamSingleTargetPars.R - -
    -
    - -

    Change the split-beam single target settings for Echoview virtual variable of type split beam (method 1) and split-eabm (method 2)/

    - -
    +
    MaximumStdDevOfMinorAxisAngles
    +

    =NULL (numeric) maximum standard deviation of Minor axis angles (degrees)

    - 
    EVsplitBeamSingleTargetPars(EVFile, acoVarName,
-  BeamCompensationModel = "SimradLobe", MaximumBeamCompensation = NULL,
-  MaximumStdDevOfMajorAxisAngles = NULL,
-  MaximumStdDevOfMinorAxisAngles = NULL, verbose = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    EVFile

    ("COMIDispatch) An Echoview file COM object

    acoVarName

    (character) Name of Echoview single target virtual variable

    BeamCompensationModel

    ='SimradLOBE' c('Simrad LOBE','BioSonics','HTI','Furuno','Sonic')Beam compensation model

    MaximumBeamCompensation

    =NULL (numeric)

    MaximumStdDevOfMajorAxisAngles

    =NULL (numeric) maximum standard deviation of Major axis angles (degrees)

    MaximumStdDevOfMinorAxisAngles

    =NULL (numeric) maximum standard deviation of Minor axis angles (degrees)

    verbose

    = FALSE (boolean)

    - -

    Value

    -

    list $settings 2 column data frame of pre-change and post-change parameter values , $msg= vector of messages

    - -

    Details

    +
    verbose
    +

    = FALSE (boolean)

    -

    This function will work with split-beam single target detection viritual variables (methods 1 and 2).

    +
    +
    +

    Value

    -

    Note

    +

    list $settings 2 column data frame of pre-change and post-change parameter values , $msg= vector of messages

    +
    +
    +

    Details

    +

    This function will work with split-beam single target detection viritual variables (methods 1 and 2).

    +
    +
    +

    Note

    THis function has only been tested using Simrad EK60 split-beam data

    - - -
    - -
  • Note
    • - +
    -
    - -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/QuitEchoview.html b/docs/reference/QuitEchoview.html index cc20695..730da02 100644 --- a/docs/reference/QuitEchoview.html +++ b/docs/reference/QuitEchoview.html @@ -1,191 +1,107 @@ - - - - - - - -Close an Echoview instance through COM scripting — QuitEchoview • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Close an Echoview instance through COM scripting — QuitEchoview • EchoviewR + Skip to contents + +
    -
    -
    -

    Close an Echoview instance through COM scripting

    - Source: R/EVQuitEchoview.R, R/EVStartQuitEchoview.R - +
    +

    Close an Echoview instance through COM scripting

    + Source: R/EVQuitEchoview.R +
    QuitEchoview.Rd
    -
    - +

    This function opens an Echoview instance

    -

    This function closes an Echoview instance through COM scripting

    -
    - 
    QuitEchoview(EVAppObj)
-
-QuitEchoview(EVAppObj)
    - -

    Arguments

    - - - - - - - - - - -
    EVAppObj

    An Echoview Application COM object

    EVAppObj

    Echoview Application Object

    - -

    Value

    +
    +

    Usage

    + 
    QuitEchoview(EVAppObj)
    +
    -

    Termination of the application and removal of the Echoview instance object

    -

    an Echoview Application object

    - -

    References

    +
    +

    Arguments

    +
    EVAppObj
    +

    An Echoview Application COM object

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj=StartEchoview()
-QuitEchoview(EVAppObj)
+
    Termination of the application and removal of the Echoview instance object
    
+
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    -# }
    EVAppObj <- StartEchoview()
    #> 2018-11-01 10:55:04: Opening Echoview
    #> Warning: Couldn't get clsid from the string
    #> Error: Invalid class string
    -
    -
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/StartEchoview.html b/docs/reference/StartEchoview.html index d1b8418..1964286 100644 --- a/docs/reference/StartEchoview.html +++ b/docs/reference/StartEchoview.html @@ -1,176 +1,100 @@ - - - - - - - -Start an Echoview instance through COM scripting — StartEchoview • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Start an Echoview instance through COM scripting — StartEchoview • EchoviewR + Skip to contents + +
    -
    -
    -

    Start an Echoview instance through COM scripting

    - Source: R/EVStartEchoview.R, R/EVStartQuitEchoview.R - +
    +

    Start an Echoview instance through COM scripting

    + Source: R/EVStartEchoview.R +
    StartEchoview.Rd
    -
    - +

    This function opens an Echoview instance

    -

    This function opens an Echoview instance through COM scripting

    -
    - 
    StartEchoview()
-
-StartEchoview()
    - -

    Value

    - -

    an object of class COMDispatch

    -

    an Echoview Application object

    - -

    References

    +
    +

    Usage

    + 
    StartEchoview()
    +
    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +

    Value

    -

    Examples

    - 
    # NOT RUN {
-EVAppObj=StartEchoview()
-
-# }
    EVAppObj <- StartEchoview()
    #> 2018-11-01 10:55:06: Opening Echoview
    #> Warning: Couldn't get clsid from the string
    #> Error: Invalid class string
    -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    -
  • References
    • - -
  • Examples
    • - +
    +

    Examples

    + 
    if (FALSE) {
+EVAppObj=StartEchoview()
+
+}
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/centreLawnOnPosition.html b/docs/reference/centreLawnOnPosition.html index 7b2413e..349d152 100644 --- a/docs/reference/centreLawnOnPosition.html +++ b/docs/reference/centreLawnOnPosition.html @@ -1,202 +1,137 @@ - - - - - - - -Centre a regular rectangular survey on a given position — centreLawnOnPosition • EchoviewR +Centre a regular rectangular survey on a given position — centreLawnOnPosition • EchoviewR + Skip to contents + - - - +
    +
    +
    +

    Centre a regular rectangular survey on a given position

    + Source: R/surveyPlanning.R +
    centreLawnOnPosition.Rd
    +
    +
    +

    Centres a regular rectangular survey on a desired latitude and longitude

    +
    +
    +

    Usage

    + 
    centreLawnOnPosition(
+  centreLon,
+  centreLat,
+  proj4string = NULL,
+  tolerance = 20,
+  ...
+)
    +
    - +
    +

    Arguments

    +
    centreLon
    +

    Desired centre location of survey

    - - +
    centreLat
    +

    Desired centre location of survey

    - - +
    proj4string
    +

    projection string of class CRS-class. If NULL defaults to "+proj=longlat +datum=WGS84"

    - - - - - - -
    -
    - +
    tolerance
    +

    maximum distance (in metres) between desired survey centre and realised survey centre

    - -
    -
    -
    -
    -

    Centre a regular rectangular survey on a given position

    - Source: R/surveyPlanning.R - -
    +
    ...
    +

    other arguments to be passed into lawnSurvey

    -
    - -

    Centres a regular rectangular survey on a desired latitude and longitude

    +
    +
    +

    Value

    -
    - 
    centreLawnOnPosition(centreLon, centreLat, proj4string = NULL,
-  tolerance = 20, ...)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    centreLon

    Desired centre location of survey

    centreLat

    Desired centre location of survey

    proj4string

    projection string of class CRS-class. If NULL defaults to "+proj=longlat +datum=WGS84"

    tolerance

    maximum distance (in metres) between desired survey centre and realised survey centre

    ...

    other arguments to be passed into lawnSurvey

    - -

    Value

    +

    Line transect coordinates (lon, lat) as specified in lawnSurvey

    -

    Line transect coordinates (lon, lat) as specified in lawnSurvey

    - -

    Examples

    - 
    # NOT RUN {
-coords=centreLawnOnPosition(centreLon=-170,centreLat=-60,lineLengthkm=2,lineSpacingkm=0.5,
-startBearingdeg=30,numOfLines=5)
-plot(0,0,xlim=range(coords[,1]),ylim=range(coords[,2]),type='n',
-xlab='Longitude, deg',ylab='Latitude, deg')
-arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2],
-      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
-text(coords,row.names(coords),cex=0.6)
-points(coords[1,1],coords[1,2],col='blue',pch=17,cex=2)
-points(coords[nrow(coords),1],coords[nrow(coords),2],col='blue',pch=15,cex=2)
-points(-170,-60,col='purple',pch=19,cex=2)
-points(geomean(coords),col='red',pch=19,cex=1)
-legend('bottomright',c('Beginning','End','Desired centre','Actual centre'),
- col=c('blue','blue','purple','red'),pch=c(17,15,19,19),pt.cex=c(1,1,2,1))
-# }
    -
    - -
    - +
    +

    Examples

    + 
    if (FALSE) {
+coords=centreLawnOnPosition(centreLon=-170,centreLat=-60,lineLengthkm=2,lineSpacingkm=0.5,
+startBearingdeg=30,numOfLines=5)
+plot(0,0,xlim=range(coords[,1]),ylim=range(coords[,2]),type='n',
+xlab='Longitude, deg',ylab='Latitude, deg')
+arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2], 
+      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
+text(coords,row.names(coords),cex=0.6)
+points(coords[1,1],coords[1,2],col='blue',pch=17,cex=2)
+points(coords[nrow(coords),1],coords[nrow(coords),2],col='blue',pch=15,cex=2)
+points(-170,-60,col='purple',pch=19,cex=2)
+points(geomean(coords),col='red',pch=19,cex=1)
+legend('bottomright',c('Beginning','End','Desired centre','Actual centre'),
+ col=c('blue','blue','purple','red'),pch=c(17,15,19,19),pt.cex=c(1,1,2,1))
+}
+
    +
    + -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/centreZigZagOnPosition.html b/docs/reference/centreZigZagOnPosition.html index 91c5761..3fe401b 100644 --- a/docs/reference/centreZigZagOnPosition.html +++ b/docs/reference/centreZigZagOnPosition.html @@ -1,209 +1,141 @@ - - - - - - +Centre an zig-zag line transect survey on a given position — centreZigZagOnPosition • EchoviewR + Skip to contents + -Centre an zig-zag line transect survey on a given position — centreZigZagOnPosition • EchoviewR +
    +
    +
    +

    Centre an zig-zag line transect survey on a given position

    + Source: R/surveyPlanning.R +
    centreZigZagOnPosition.Rd
    +
    - - - +
    +

    Centres a zig-zag survey on a desired latitude and longitude

    +
    +
    +

    Usage

    + 
    centreZigZagOnPosition(
+  centreLon,
+  centreLat,
+  proj4string = CRS("+proj=longlat +datum=WGS84"),
+  tolerance = 20,
+  ...
+)
    +
    +
    +

    Arguments

    +
    centreLon
    +

    Desired centre location of survey

    - - - +
    centreLat
    +

    Desired centre location of survey

    +
    proj4string
    +

    projection string of class CRS-class

    - - - - - - - - -
    -
    - - -
    +
    ...
    +

    other arguments to be passed into \linkzigzagSurvey

    -
    -
    -
    -

    Centre an zig-zag line transect survey on a given position

    - Source: R/surveyPlanning.R - -
    - -
    +
    +
    +

    Value

    -

    Centres a zig-zag survey on a desired latitude and longitude

    - -
    - 
    centreZigZagOnPosition(centreLon, centreLat,
-  proj4string = CRS("+proj=longlat +datum=WGS84"), tolerance = 20, ...)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    centreLon

    Desired centre location of survey

    centreLat

    Desired centre location of survey

    proj4string

    projection string of class CRS-class

    tolerance

    maximum distance (in metres) between desired survey centre and realised survey centre

    ...

    other arguments to be passed into \linkzigzagSurvey

    - -

    Value

    +

    Line transect coordinates as specified in zigzagSurvey

    -

    Line transect coordinates as specified in zigzagSurvey

    - -

    Details

    -

    The call of zigzagSurvey has unrotated=FALSE

    - +
    +
    +

    Details

    +

    The call of zigzagSurvey has unrotated=FALSE

    +
    -

    Examples

    - 
    # NOT RUN {
-coords=centreZigZagOnPosition(centreLon=-33,centreLat=-57,lineLengthkm=60,startBearingdeg=30,
-rotationdeg=10,numOfLines=21)
-plot(0,0,xlim=range(coords[,1]),ylim=range(coords[,2]),
-type='n',xlab='Longitude, deg',ylab='Latitude, deg')
-arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2],
-      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
-text(coords,row.names(coords),cex=0.6)
-points(coords[1,1],coords[1,2],col='blue',pch=17,cex=2)
-points(coords[nrow(coords),1],coords[nrow(coords),2],col='blue',pch=15,cex=2)
-points(-100,-60,col='purple',pch=19,cex=2)
-points(geomean(coords),col='red',pch=19,cex=1)
-legend('topright',c('Beginning','End','Desired centre','Actual centre'),
- col=c('blue','blue','purple','red'),pch=c(17,15,19,19),pt.cex=c(1,1,2,1))
-
-# }
    -
    - - - -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/combineEVL.html b/docs/reference/combineEVL.html index ba4b528..04ac3e4 100644 --- a/docs/reference/combineEVL.html +++ b/docs/reference/combineEVL.html @@ -1,173 +1,98 @@ - - - - - - - -Combine Echoview line objects — combineEVL • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Combine Echoview line objects — combineEVL • EchoviewR + Skip to contents + +
    -
    -
    -

    Combine Echoview line objects

    - Source: R/combineEVL.R - +
    +

    Combine Echoview line objects

    + Source: R/combineEVL.R +
    combineEVL.Rd
    -
    - +

    This function combines evl class objects into a single .evl file

    -
    - 
    combineEVL(evlL)
    - -

    Arguments

    - - - - - - -
    evlL

    list of objects of class evl, typically resulting from a class of readevl2R

    - -

    Value

    +
    +

    Usage

    + 
    combineEVL(evlL)
    +
    -

    an evl class object

    - -

    See also

    +
    +

    Arguments

    +
    evlL
    +

    list of objects of class evl, typically resulting from a class of readevl2R

    -

    readevl2R writeRevl2file

    +
    +
    +

    Value

    -
    - +
    +

    See also

    +

    readevl2R writeRevl2file

    +
    -
  • See also
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/exportMIF.html b/docs/reference/exportMIF.html index 2821e67..1259fd2 100644 --- a/docs/reference/exportMIF.html +++ b/docs/reference/exportMIF.html @@ -1,202 +1,134 @@ - - - - - - - -Write a map info file for import into Echoview. — exportMIF • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +centreLawnOnPosition.">Write a map info file for import into Echoview. — exportMIF • EchoviewR + Skip to contents + +
    -
    -
    -

    Write a map info file for import into Echoview.

    - Source: R/exportMIF.R - +
    +

    Write a map info file for import into Echoview.

    + Source: R/exportMIF.R +
    exportMIF.Rd
    -
    - +

    This function writes a polygon MIF file for import into Echoview and will typically be used to export survey line transects from, for example, -centreLawnOnPosition.

    - +centreLawnOnPosition.

    - 
    exportMIF(coords, pathAndFileName, pointNameExport = FALSE,
-  pointNameScaleFactor = c(0.05, 0.03))
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    coords

    a set of coordinates as a two column (longitude and latitude) matrix.

    pathAndFileName

    character string MIF file export path and filename

    pointNameExport

    Boolean (default=FALSE) export the name of each point.

    pointNameScaleFactor

    =c(0.005,0.03) see details

    - -

    Value

    +
    +

    Usage

    + 
    exportMIF(
+  coords,
+  pathAndFileName,
+  pointNameExport = FALSE,
+  pointNameScaleFactor = c(0.05, 0.03)
+)
    +
    + +
    +

    Arguments

    +
    coords
    +

    a set of coordinates as a two column (longitude and latitude) matrix.

    + + +
    pathAndFileName
    +

    character string MIF file export path and filename

    -

    Nothing

    + +
    pointNameExport
    +

    Boolean (default=FALSE) export the name of each point.

    + + +
    pointNameScaleFactor
    +

    =c(0.005,0.03) see details

    + +
    +
    +

    Value

    -

    Details

    +

    Nothing

    +
    +
    +

    Details

    Exporting the name of each point uses the row name in the coords argument.

    The pointNameScaleFactor argument is a two element numeric vector specifying the bounding box for each point name. The bounding box is calculated for point name i by specifying the lower left hand corner of the point name position, with the upper right hand corner specified as c(lon_i,lat_i)+diff(range(lon_1..n,lat_1..n))*pointNameScaleFactor where n is the total number of points i.e nrow(coords)

    - +
    -

    Examples

    - 
    # NOT RUN {
-coords=centreLawnOnPosition(centreLon=-33,centreLat=-55.5,lineLengthkm=100,lineSpacingkm=10,
-startBearingdeg=30,numOfLines=50)
-exportMIF(coords=coords,pathAndFileName='c:\\Users\\martin_cox\\Documents\\test4.mif')
-# }
    -
    -
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/getRaws.html b/docs/reference/getRaws.html index 9a695d7..e0af985 100644 --- a/docs/reference/getRaws.html +++ b/docs/reference/getRaws.html @@ -1,222 +1,157 @@ - - - - - - +Find Raw files based on Time and Date, providing folder containing all Raw files — getRaws • EchoviewR + Skip to contents + -Find Raw files based on Time and Date, providing folder containing all Raw files — getRaws • EchoviewR +
    +
    +
    +

    Find Raw files based on Time and Date, providing folder containing all Raw files

    + Source: R/getRaws.R +
    getRaws.Rd
    +
    - - - +
    +

    This functions generates datetime object based on the raw data filenames and selects the required raw files according to +a user defined start and end time

    +
    +
    +

    Usage

    + 
    getRaws(
+  dir,
+  StartDate,
+  StartTime,
+  EndDate,
+  EndTime,
+  tzraw = "UTC",
+  tzinp = "UTC",
+  timebuffer = 0,
+  fileSlope = FALSE
+)
    +
    +
    +

    Arguments

    +
    dir
    +

    = path [character]

    - - - +
    StartDate
    +

    [character] Date under the shape of YYYYMMDD (example: 20171127)

    +
    StartTime
    +

    [character] Time under the shape of HHMMSS (example: 085617)

    - - - - - - - - -
    -
    - - -
    +
    EndTime
    +

    [character] Time under the shape of HHMMSS (example: 085617)

    -
    -
    -
    -

    Find Raw files based on Time and Date, providing folder containing all Raw files

    - Source: R/getRaws.R - -
    -
    - -

    This functions generates datetime object based on the raw data filenames and selects the required raw files according to -a user defined start and end time

    - -
    +
    tzraw
    +

    ="UTC"[character] timezone under which the raw files were recorded e.g.UTC or Australia/Brisbane or AEST

    - 
    getRaws(dir, StartDate, StartTime, EndDate, EndTime, tzraw = "UTC",
-  tzinp = "UTC", timebuffer = 0, fileSlope = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    dir

    = path [character]

    StartDate

    [character] Date under the shape of YYYYMMDD (example: 20171127)

    StartTime

    [character] Time under the shape of HHMMSS (example: 085617)

    EndDate

    [character] Date under the shape of YYYYMMDD (example: 20171127)

    EndTime

    [character] Time under the shape of HHMMSS (example: 085617)

    tzraw

    ="UTC"[character] timezone under which the raw files were recorded e.g.UTC or Australia/Brisbane or AEST

    tzinp

    ="UTC"[character] timezone of the entered start and end points e.g.UTC or Australia/Brisbane or AEST

    timebuffer

    = 0 [numeric in seconds] add a buffer around the times for which files should be selected

    fileSlope

    = FALSE [boolean] If TRUE the raw file that partly falls within the start of the time interval.

    - -

    Value

    -

    charater array with raw data filenames

    +
    tzinp
    +

    ="UTC"[character] timezone of the entered start and end points e.g.UTC or Australia/Brisbane or AEST

    + + +
    timebuffer
    +

    = 0 [numeric in seconds] add a buffer around the times for which files should be selected

    + + +
    fileSlope
    +

    = FALSE [boolean] If TRUE the raw file that partly falls within the start of the time interval.

    + +
    +
    +

    Value

    -

    Note

    +

    charater array with raw data filenames

    +
    +
    +

    Note

    Dependencies: lubridate - Requires lubridate package for easy computation of time intervals

    - +
    -

    Examples

    - 
    # NOT RUN {
-StartDate = 20170901
-StartTime = "080917"
-EndDate = 20170901
-EndTime = 172356
-rawdir = "F:\\RawFolder\\"
-getRaws(dir,StartDate, StartTime,EndDate, EndTime, tzraw="UTC", tzinp="UTC")
-
-# }
     
- 
-
    -
    - -
    - -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/index.html b/docs/reference/index.html index 717a9dc..5dac094 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,648 +1,521 @@ - - - - - - - -Function reference • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Function reference • EchoviewR + + Skip to contents + +
    -
    -
    -

    Reference

    +
    +

    Function reference

    - +
    +

    All functions

    + + -
    - - - +
    + + + -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    All functions

    -

    -
    -

    CCAMLR_SWARMR04.EV

    -

    Echoview template for krill swarms based analysis developed during the CCAMLR SG-ASAM 2017 meeting.

    -

    centreLawnOnPosition()

    -

    Centre a regular rectangular survey on a given position

    -

    centreZigZagOnPosition()

    -

    Centre an zig-zag line transect survey on a given position

    -

    combineEVL()

    -

    Combine Echoview line objects

    -

    EVAcoVarNameFinder()

    -

    Find an acoustic variable by name

    -

    EVAddCalibrationFile()

    -

    Add a calibration file (.ecs) to a fileset

    -

    EVAddRawData()

    -

    Add raw data files to an open Echoview file (.EV)

    -

    EVAddVariable()

    -

    Add a variable to an Echoview file

    -

    EVAdjustDataRngBitmap()

    -

    Change the data range bitmap of an acoustic object

    -

    EVBottomDetection()

    -

    Bottom Detection

    -

    EVChangeVariableGrid()

    -

    Change the integration grid size and type of an Echoview acoustic variable

    -

    EVClearRawData()

    -

    Clear all files from a fileset

    -

    EVCloseFile()

    -

    Close an open Echoview file (.EV)

    -

    EVCreateEditableLine()

    -

    Create an EV Editable Line from an existing line

    -

    EVCreateFileset()

    -

    Create a new Echoview fileset

    -

    EVCreateNew()

    -

    Create a new Echoview (.EV) file and adds raw data files to it

    -

    EVDeleteLine()

    -

    Deletes an Echoview line object

    -

    EVDeleteRegionClass()

    -

    Delete an Echoview region class

    -

    EVExportEchogramToImage()

    -

    Export an Echoview acoustic variable to an image file

    -

    EVExportIntegrationAllRegions()

    -

    Export echo integration from Echoview for all regions in an Echoview acoustic variable

    -

    EVExportIntegrationByCells()

    -

    Export integration by cells for an acoustic variable

    -

    EVExportIntegrationByRegionByCells()

    -

    Export integration by region name by cells for an acoustic variable

    -

    EVExportLineAsCSV()

    -

    Export an Echoview line as a CSV file

    -

    EVExportRegionDef()

    -

    Exports an Echoview region definition

    -

    EVExportRegionDefByClass()

    -

    Exports definitions for all Echoview regions in a region class

    -

    EVExportRegionSv()

    -

    Export Sv data for an Echoview acoustic variable by region

    -

    EVExportUnderlying()

    -

    Export underlying data for an acoustic variable

    -

    EVExportWBST_FR()

    -

    Export Wideband Single Targets Frequency Response

    -

    EVFilesInFileset()

    -

    Find names of all raw files in a fileset

    -

    EVFindFilesetByName()

    -

    Find an Echoview fileset in an Echoview file

    -

    EVFindFilesetTime()

    -

    Find the time and date of the start and end of an Echoview fileset

    -

    EVFindLineByName()

    -

    Find an EV Line object by name

    -

    EVFindRegionByName()

    -

    Finds an Echoview region by name

    -

    EVFindRegionClass()

    -

    Find the class of an Echoview region object

    -

    EVFishTracking()

    -

    Detect Fish Tracks

    -

    EVGetCalibrationFileName()

    -

    Gets the calibration file name of a fileset

    -

    EVImportLine()

    -

    Import an Echoview line (EVL format) file

    -

    EVImportRegionDef()

    -

    Import an Echoview region definitions file (.evr)

    -

    EVIntegrationByRegionsByCellsExport()

    -

    Export integration by regions by cells from an Echoview acoustic variable

    -

    EVIntegrationByRegionsExport()

    -

    Export integration by regions from an Echoview acoustic variable

    -

    EVLineExportFromAcousticVarEVL()

    -

    Export an Echoview line file for an existing line associated with an Acoustic Variable.

    -

    EVmaxThresholdSet()

    -

    Sets maximum data threshold for a variable object

    -

    EVminThresholdSet()

    -

    Sets minimum data threshold for a variable object

    -

    EVNewAcousticVar()

    -

    Add a new acoustic variable

    -

    EVNewFile()

    -

    Create a new Echoview file (.EV)

    -

    EVNewFixedDepthLine()

    -

    Creates a new fixed depth Echoview line

    -

    EVNewLineRelativeRegion()

    -

    Creates a new line relative region in the current variable

    -

    EVNewRegionClass()

    -

    Create a new Echoview region class

    -

    EVOpenFile()

    -

    Open an existing Echoview file (.EV)

    -

    EVPingSubset()

    -

    Control an Echoview ping subset virtual variable using COM scripting.

    -

    EVRegionClassFinder()

    -

    Find an Echoview region class by name

    -

    EVRenameAcousticVar()

    -

    Rename an Echoview acoustic variable

    -

    EVRenameLine()

    -

    Renames an Echoview Line object

    -

    EVResampleByPingControl()

    -

    Control the 'Resample by ping' Echoview virtual variable settings using COM

    -

    EVSaveAsFile()

    -

    Perform save as operation on an open Echoview file (.EV)

    -

    EVSaveFile()

    -

    Save an open Echoview file (.EV)

    -

    EVSchoolsDetect()

    -

    Schools Detection in Echoview

    -

    EVSchoolsDetSet()

    -

    Change schools detection settings

    -

    EVSetAcoVarDisplayDepth()

    -

    Set the minimum and maximum display depth for an acoustic variable.

    -

    EVsetExclusionLines()

    -

    Change the top and bottom exclusion lines in an Echoview acoustic variable

    -

    EVShiftRegionDepth()

    -

    Change the depth of an Echoview Region

    -

    EVShiftRegionTime()

    -

    Change the time of an Echoview Region

    -

    EVsingleTargetPars()

    -

    Change the single target settings for Echoview single target virtual variable

    -

    EVsplitBeamSingleTargetPars()

    -

    Change the SPLIT-BEAM single target settings for an Echoview split-beam single target virtual variable

    -

    EVSTWideband()

    -

    Broadband Single target detection

    -

    EVVersion()

    -

    Get the current version of Echoview

    -

    exportMIF()

    -

    Write a map info file for import into Echoview.

    -

    getRaws()

    -

    Find Raw files based on Time and Date, providing folder containing all Raw files

    -

    jhF()

    -

    The Jolly and Hampton (1990) estimator

    -

    jhMultipleStrataF()

    -

    Estimate mean and variance across multiple strata using the Jolly and Hampton (1990) method

    -

    lawnSurvey()

    -

    Generate a coordinate list for a regular rectangular survey

    -

    makeEVRfromDT()

    -

    Create an Echoview EVR (Region definition) file from depth and time intervals

    -

    makeRectRegion()

    -

    Make a rectangular Echoview region (EVR) file.

    -

    modifyECS()

    -

    A function to modify Ex60/70 Echoview calibration files (ECS files)

    -

    msDATEConversion()

    -

    Convert a Microsoft DATE object to a human readable date and time

    -

    QuitEchoview() QuitEchoview()

    -

    Close an Echoview instance through COM scripting

    -

    readevl2R()

    -

    Read and Echoview line (.evl) file into R

    -

    readUnderlyingDataCSV()

    -

    Read CSV resulting from a call of EVExportUnderlying()

    -

    schoolRelativeDimension()

    -

    Calculate the relative dimension of a school

    -

    StartEchoview() StartEchoview()

    -

    Start an Echoview instance through COM scripting

    -

    writeRevl2file()

    -

    Write an Echoview line (.evl) file

    -

    zigzagSurvey()

    -

    Generate a coordinate list for a zig-zag survey

    -
    +
    + + CCAMLR_SWARMR04.EV +
    +
    Echoview template for krill swarms based analysis developed during the CCAMLR SG-ASAM 2017 meeting.
    +
    + + centreLawnOnPosition() +
    +
    Centre a regular rectangular survey on a given position
    +
    + + centreZigZagOnPosition() +
    +
    Centre an zig-zag line transect survey on a given position
    +
    + + combineEVL() +
    +
    Combine Echoview line objects
    +
    + + EVAcoVarCheck() +
    +
    Check an Echoview acoustic variable
    +
    + + EVAcoVarDataGenerator() +
    +
    Control an Echoview data generator variable using COM scripting.
    +
    + + EVAcoVarNameFinder() +
    +
    Find an acoustic variable by name
    +
    + + EVAddCalibrationFile() +
    +
    Add a calibration file (.ecs) to a fileset
    +
    + + EVAddRawData() +
    +
    Add raw data files to an open Echoview file (.EV)
    +
    + + EVAddVariable() +
    +
    Add a variable to an Echoview file
    +
    + + EVAdjustDataRngBitmap() +
    +
    Change the data range bitmap of an acoustic object
    +
    + + EVBottomDetection() +
    +
    Bottom Detection
    +
    + + EVChangeVariableGrid() +
    +
    Adjust the Echoview virtual variable 'Background noise removal' using COM
    +
    + + EVClearRawData() +
    +
    Clear all files from a fileset
    +
    + + EVCloseFile() +
    +
    Close an open Echoview file (.EV)
    +
    + + EVCreateEditableLine() +
    +
    Create an EV Editable Line from an existing line
    +
    + + EVCreateFileset() +
    +
    Create a new Echoview fileset
    +
    + + EVCreateNew() +
    +
    Create a new Echoview (.EV) file and adds raw data files to it
    +
    + + EVDeleteLine() +
    +
    Deletes an Echoview line object
    +
    + + EVDeleteRegionClass() +
    +
    Delete an Echoview region class
    +
    + + EVExportEchogramToImage() +
    +
    Export an Echoview acoustic variable to an image file
    +
    + + EVExportIntegrationAllRegions() +
    +
    Export echo integration from Echoview for all regions in an Echoview acoustic variable
    +
    + + EVExportIntegrationByCells() +
    +
    Export integration by cells for an acoustic variable
    +
    + + EVExportIntegrationByRegionByCells() +
    +
    Export integration by region name by cells for an acoustic variable
    +
    + + EVExportLineAsCSV() +
    +
    Export an Echoview line as a CSV file
    +
    + + EVExportRegionDef() +
    +
    Exports an Echoview region definition
    +
    + + EVExportRegionDefByClass() +
    +
    Exports definitions for all Echoview regions in a region class
    +
    + + EVExportRegionSv() +
    +
    Export Sv data for an Echoview acoustic variable by region
    +
    + + EVExportUnderlying() +
    +
    Export underlying data for an acoustic variable
    +
    + + EVExportWBST_FR() +
    +
    Export Wideband Single Targets Frequency Response
    +
    + + EVFilesInFileset() +
    +
    Find names of all raw files in a fileset
    +
    + + EVFindFilesetByName() +
    +
    Find an Echoview fileset in an Echoview file
    +
    + + EVFindFilesetTime() +
    +
    Find the time and date of the start and end of an Echoview fileset
    +
    + + EVFindLineByName() +
    +
    Find an EV Line object by name
    +
    + + EVFindRegionByName() +
    +
    Finds an Echoview region by name
    +
    + + EVFindRegionClass() +
    +
    Find the class of an Echoview region object
    +
    + + EVFishTracking() +
    +
    Detect Fish Tracks
    +
    + + EVFreqSubset() +
    +
    Frequency subset from Wideband data.
    +
    + + EVGetCalibrationFileName() +
    +
    Gets the calibration file name of a fileset
    +
    + + EVgetCalParValues() +
    +
    Get calibration settings pf an Echoview acoustic variable using COM
    +
    + + EVGetVariables() +
    +
    Get List of all variables
    +
    + + EVImportLine() +
    +
    Import an Echoview line (EVL format) file
    +
    + + EVImportRegionDef() +
    +
    Import an Echoview region definitions file (.evr)
    +
    + + EVIntegrationByRegionsByCellsExport() +
    +
    Export integration by regions by cells from an Echoview acoustic variable
    +
    + + EVIntegrationByRegionsExport() +
    +
    Export integration by regions from an Echoview acoustic variable
    +
    + + EVLineExportFromAcousticVarEVL() +
    +
    Export an Echoview line file for an existing line associated with an Acoustic Variable.
    +
    + + EVmaxThresholdSet() +
    +
    Sets maximum data threshold for a variable object
    +
    + + EVminThresholdSet() +
    +
    Sets minimum data threshold for a variable object
    +
    + + EVNewAcousticVar() +
    +
    Add a new acoustic variable
    +
    + + EVNewFile() +
    +
    Create a new Echoview file (.EV)
    +
    + + EVNewFixedDepthLine() +
    +
    Creates a new fixed depth Echoview line
    +
    + + EVNewLineRelativeRegion() +
    +
    Creates a new line relative region in the current variable
    +
    + + EVNewRegionClass() +
    +
    Create a new Echoview region class
    +
    + + EVOpenFile() +
    +
    Open an existing Echoview file (.EV)
    +
    + + EVPingSubset() +
    +
    Control an Echoview ping subset virtual variable using COM scripting.
    +
    + + EVRegionClassFinder() +
    +
    Find an Echoview region class by name
    +
    + + EVRenameAcousticVar() +
    +
    Rename an Echoview acoustic variable
    +
    + + EVRenameLine() +
    +
    Renames an Echoview Line object
    +
    + + EVResampleByPingControl() +
    +
    Control the 'Resample by ping' Echoview virtual variable settings using COM
    +
    + + EVSaveAsFile() +
    +
    Perform save as operation on an open Echoview file (.EV)
    +
    + + EVSaveFile() +
    +
    Save an open Echoview file (.EV)
    +
    + + EVSchoolsDetect() +
    +
    Schools Detection in Echoview
    +
    + + EVSchoolsDetSet() +
    +
    Change schools detection settings
    +
    + + EVSchoolsDetSetV12() +
    +
    Change schools detection settings for Echvoiew >=V12
    +
    + + EVSetAcoVarDisplayDepth() +
    +
    Set the minimum and maximum display depth for an acoustic variable.
    +
    + + EVsetExclusionLines() +
    +
    Change the top and bottom exclusion lines in an Echoview acoustic variable
    +
    + + EVShiftRegionDepth() +
    +
    Change the depth of an Echoview Region
    +
    + + EVShiftRegionTime() +
    +
    Change the time of an Echoview Region
    +
    + + EVsingleTargetPars() +
    +
    Change the single target settings for Echoview single target virtual variable
    +
    + + EVsplitBeamSingleTargetPars() +
    +
    Change the SPLIT-BEAM single target settings for an Echoview split-beam single target virtual variable
    +
    + + EVSTWideband() +
    +
    Broadband Single target detection
    +
    + + EVVersion() +
    +
    Get the current version of Echoview
    +
    + + exportMIF() +
    +
    Write a map info file for import into Echoview.
    +
    + + getRaws() +
    +
    Find Raw files based on Time and Date, providing folder containing all Raw files
    +
    + + jhF() +
    +
    The random sampling theory estimator of Jolly and Hampton (1990)
    +
    + + jhMultipleStrataF() +
    +
    Estimate mean and variance across multiple strata using the Jolly and Hampton (1990) method
    +
    + + lawnSurvey() +
    +
    Generate a coordinate list for a regular rectangular survey
    +
    + + makeEVRfromDT() +
    +
    Create an Echoview EVR (Region definition) file from depth and time intervals
    +
    + + makeRectRegion() +
    +
    Make a rectangular Echoview region (EVR) file.
    +
    + + modifyECS() +
    +
    A function to modify Ex60/70 Echoview calibration files (ECS files)
    +
    + + msDATEConversion() +
    +
    Convert a Microsoft DATE object to a human readable date and time
    +
    + + QuitEchoview() +
    +
    Close an Echoview instance through COM scripting
    +
    + + readevl2R() +
    +
    Read and Echoview line (.evl) file into R
    +
    + + readUnderlyingDataCSV() +
    +
    Read CSV resulting from a call of EVExportUnderlying()
    +
    + + schoolRelativeDimension() +
    +
    Calculate the relative dimension of a school
    +
    + + StartEchoview() +
    +
    Start an Echoview instance through COM scripting
    +
    + + writeRevl2file() +
    +
    Write an Echoview line (.evl) file
    +
    + + zigzagSurvey() +
    +
    Generate a coordinate list for a zig-zag survey
    +
    +
    - -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/jhF.html b/docs/reference/jhF.html index 4f12c28..3df95c2 100644 --- a/docs/reference/jhF.html +++ b/docs/reference/jhF.html @@ -1,213 +1,142 @@ - - - - - - - -The Jolly and Hampton (1990) estimator — jhF • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +The random sampling theory estimator of Jolly and Hampton (1990) — jhF • EchoviewR + Skip to contents + +
    -
    -
    -

    The Jolly and Hampton (1990) estimator

    - Source: R/JollyAndHampton1990.R - +
    +

    The random sampling theory estimator of Jolly and Hampton (1990)

    + Source: R/JollyAndHampton1990.R +
    jhF.Rd
    -
    - -

    The Jolly and Hampton (1990) estimator is often used to calculate mean pelagic animal densities and associated variances.

    - +
    +

    The Jolly and Hampton (1990) estimator is often used to calculate mean pelagic animal densities and associated variances. Users are encouraged to review Jolly and Hampton (1990) before using this function.

    - 
    jhF(transectLength, transectMeanDen, transectName = NULL,
-  svyName = NULL, area = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    transectLength

    vector of parameter lengths

    transectMeanDen

    transect weighted mean densities. See details.

    transectName

    =NULL Optional character vector of transect names.

    svyName

    =NULL Optional character variable of survey names. Must be used if the jhMultipleStrataF function is used to estimate mean and variance across multiple strata.

    area

    =NULL Optional character variable of the survey or stratum name. Must be used if the jhMultipleStrataF function is used to estimate mean and variance across multiple strata.

    - -

    Value

    +
    +

    Usage

    + 
    jhF(
+  transectLength,
+  transectMeanDen,
+  transectName = NULL,
+  svyName = NULL,
+  area = NULL
+)
    +
    -

    two element list.

    - -

    Details

    +
    +

    Arguments

    +
    transectLength
    +

    [numeric, vector] of transect lengths

    -

    The transectMeanDen In the case of acoustic data, each element (areal density value) is multiplied by the integration interval (along transect) length. The distance multiplication must take place outside of this function.

    - -

    References

    -

    Jolly, G. M., and Hampton, I. 1990. A stratified random transect design for acoustic surveys of fish stocks. Canadian Journal of Fisheries and Aquatic Sciences, 47: 1282-1291.

    - -

    See also

    +
    transectMeanDen
    +

    [numeric, vector] transect weighted mean densities. See details.

    -

    jhMultipleStrataF

    - -

    Examples

    - 
    # NOT RUN {
-tLengths=c(77.67,78.28,78.91,80.22,78.07,73.60,78.53,78.39,78.52,79.48)
-denV=c(158.03,159.50,96.41,133.86,246.60,243.95,122.65,276.92,59.83,89.90)
-svyA=80*100*1e6
-jhF(transectLength=tLengths,
-transectMeanDen=denV,
-transectName=NULL,svyName='test',area=svyA)
-# }
    -
    - -
    +
    area
    +

    =NULL Optional variable of the survey or stratum area. Must be used if the jhMultipleStrataF function is used to estimate mean and variance across multiple strata.

    -
    -
    +
    +
    +

    Value

    + + +

    two element list. $summaryStats and $transects. See details

    +
    +
    +

    Details

    +

    The transectMeanDen In the case of acoustic data, each element (areal density value) is multiplied by the integration interval (along transect) length. The distance multiplication must take place outside of this function.

    +

    The function returns a two element list. The first element $summaryStats is a vector with names $svy - the survey name; MeanWeightedDensity - mean +density as per Jolly and Hampton (1990) $variance - variance calculated as per Jolly and Hampton (1990), and $totalTransectLength total transect length. If survey area is provided area then biomass $biomass with confidence internal $lowerIntervalBiomass and $upperIntervalBiomass. The secord element of the list returned in $transects statistics fo each trasect.

    +
    +
    +

    References

    +

    Jolly, G. M., and Hampton, I. 1990. A stratified random transect design for acoustic surveys of fish stocks. Canadian Journal of Fisheries and Aquatic Sciences, 47: 1282-1291.

    +
    +
    +

    See also

    +

    jhMultipleStrataF

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+tLengths=c(77.67,78.28,78.91,80.22,78.07,73.60,78.53,78.39,78.52,79.48)
+denV=c(158.03,159.50,96.41,133.86,246.60,243.95,122.65,276.92,59.83,89.90)
+svyA=80*100*1e6
+jhF(transectLength=tLengths,
+transectMeanDen=denV,
+transectName=NULL,svyName='test',area=svyA)
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/jhMultipleStrataF.html b/docs/reference/jhMultipleStrataF.html index dbff62f..b16e90c 100644 --- a/docs/reference/jhMultipleStrataF.html +++ b/docs/reference/jhMultipleStrataF.html @@ -1,200 +1,124 @@ - - - - - - - -Estimate mean and variance across multiple strata using the Jolly and Hampton (1990) method — jhMultipleStrataF • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Estimate mean and variance across multiple strata using the Jolly and Hampton (1990) method — jhMultipleStrataF • EchoviewR + Skip to contents + +
    -
    -
    -

    Estimate mean and variance across multiple strata using the Jolly and Hampton (1990) method

    - Source: R/JollyAndHampton1990.R - +
    +

    Estimate mean and variance across multiple strata using the Jolly and Hampton (1990) method

    + Source: R/JollyAndHampton1990.R +
    jhMultipleStrataF.Rd
    -
    - +

    Estimate mean and variance across multiple strata using the Jolly and Hampton (1990) method

    -
    - 
    jhMultipleStrataF(strata)
    - -

    Arguments

    - - - - - - -
    strata

    list of multiple strata, each element must be the result of a call of jhF. See details.

    - -

    Details

    - -

    The call of jhF used to create an element in the strata argument must have the name of the stratum and the stratum area. -#'@references Jolly, G. M., and Hampton, I. 1990. A stratified random transect design for acoustic surveys of fish stocks. Canadian Journal of Fisheries and Aquatic Sciences, 47: 1282-1291.

    - -

    See also

    - -

    jhF

    - - -

    Examples

    - 
    # NOT RUN {
-svy1=jhF(transectLength=tLengths,
-transectMeanDen=denV,
-transectName=NULL,svyName='test',area=svyA)
-svy2=jhF(transectLength=tLengths,
-transectMeanDen=denV,
-transectName=NULL,svyName='test',area=svyA)
-
-jhMultipleStrataF(strata=list(svy1,svy2))
-
-svy3=jhF(transectLength=tLengths,
-transectMeanDen=denV,
-transectName=NULL,svyName='test',area=svyA*2)
-
-jhMultipleStrataF(strata=list(svy1,svy3))
+    
    
+    
    Usage
    
+    
    jhMultipleStrataF(strata)
    
+    
    
 
-svy4=jhF(transectLength=tLengths,
-transectMeanDen=denV*2,
-transectName=NULL,svyName='test',area=svyA)
+    
    
+    
    Arguments
    
+    
    strata
    
+
    list of multiple strata, each element must be the result of a call of jhF.  See details.
    
 
-jhMultipleStrataF(strata=list(svy1,svy4))
+
    
+    
    
+    
    Details
    
+    
    The call of jhF used to create an element in the  strata argument must have the name of the stratum and the stratum area.
+#'@references Jolly, G. M., and Hampton, I. 1990. A stratified random transect design for acoustic surveys of fish stocks. Canadian Journal of Fisheries and Aquatic Sciences, 47: 1282-1291.
    
+    
    
+    
    
+    
    See also
    
+    
    jhF
    
+    
    
 
-# }
    -
    -
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/lawnSurvey.html b/docs/reference/lawnSurvey.html index 893b4e8..6e7af0e 100644 --- a/docs/reference/lawnSurvey.html +++ b/docs/reference/lawnSurvey.html @@ -1,219 +1,158 @@ - - - - - - - -Generate a coordinate list for a regular rectangular survey — lawnSurvey • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +South 180 deg and West 270 deg.">Generate a coordinate list for a regular rectangular survey — lawnSurvey • EchoviewR + Skip to contents + +
    -
    -
    -

    Generate a coordinate list for a regular rectangular survey

    - Source: R/surveyPlanning.R - +
    +

    Generate a coordinate list for a regular rectangular survey

    + Source: R/surveyPlanning.R +
    lawnSurvey.Rd
    -
    - +

    The coordinate list is generated in degrees decimal degree format (dd.ddd), with Southern hemisphere denoted by negative numbers. Transect length and inter-transect spacing are specified in km and bearings in degress where North 0 deg, East 90 deg, South 180 deg and West 270 deg.

    -
    - 
    lawnSurvey(startLon, startLat, lineLengthkm, lineSpacingkm,
-  startBearingdeg, numOfLines)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    startLon

    start longitude of survey.

    startLat

    start latitude of survey.

    lineLengthkm

    transect line length in km.

    lineSpacingkm

    inter-transect spacing in km.

    startBearingdeg

    Orientation of survey grid in degrees.

    numOfLines

    Number of transects.

    - -

    Value

    +
    +

    Usage

    + 
    lawnSurvey(
+  startLon,
+  startLat,
+  lineLengthkm,
+  lineSpacingkm,
+  startBearingdeg,
+  numOfLines
+)
    +
    -

    Geographical coordinate list of start and end of line positions

    - -

    See also

    +
    +

    Arguments

    +
    startLon
    +

    start longitude of survey.

    -

    zigzagSurvey

    - -

    Examples

    - 
    # NOT RUN {
-(coords=lawnSurvey(startLon=-170,startLat=-60,lineLengthkm=2,lineSpacingkm=0.5,
-startBearingdeg=30,numOfLines=5))
-plot(0,0,xlim=range(coords[,1]),
-ylim=range(coords[,2]),type='n',xlab='Longitude, deg',ylab='Latitude, deg')
-arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2],
-      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
-text(coords,row.names(coords),cex=0.6)
-points(coords[1,1],coords[1,2],col='blue',pch=17,cex=2)
-points(coords[nrow(coords),1],coords[nrow(coords),2],col='blue',pch=15,cex=2)
-legend('topright',c('Beginning','End'),col='blue',pch=c(17,15))
-# }
    -
    - +
    +

    Value

    -Martin Cox martin.cox@aad.gov.au -
    -
    +

    Data frame of geographical coordinates of start (SOL) and end of line (EOL) positions

    +
    +
    +

    Details

    +

    Line spacing can be fixed, so specified by a single number or pseudo random (random draws from a uniform distribution), which is specified by a vector of two numbers, the minimun and maximum transect separation.

    +
    +
    +

    See also

    +

    zigzagSurvey

    +
    +
    +

    Author

    +

    Martin Cox martin.cox@aad.gov.au

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+(coords=lawnSurvey(startLon=-170,startLat=-60,lineLengthkm=2,lineSpacingkm=0.5,
+startBearingdeg=30,numOfLines=5))
+plot(0,0,xlim=range(coords[,1]),
+ylim=range(coords[,2]),type='n',xlab='Longitude, deg',ylab='Latitude, deg')
+arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2], 
+      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
+text(coords,row.names(coords),cex=0.6)
+points(coords[1,1],coords[1,2],col='blue',pch=17,cex=2)
+points(coords[nrow(coords),1],coords[nrow(coords),2],col='blue',pch=15,cex=2)
+legend('topright',c('Beginning','End'),col='blue',pch=c(17,15))
+}
+
    +
    +
    -
    -
    + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/makeEVRfromDT.html b/docs/reference/makeEVRfromDT.html index 92d846c..d684586 100644 --- a/docs/reference/makeEVRfromDT.html +++ b/docs/reference/makeEVRfromDT.html @@ -1,239 +1,169 @@ - - - - - - +Create an Echoview EVR (Region definition) file from depth and time intervals — makeEVRfromDT • EchoviewR + Skip to contents + -Create an Echoview EVR (Region definition) file from depth and time intervals — makeEVRfromDT • EchoviewR +
    +
    +
    +

    Create an Echoview EVR (Region definition) file from depth and time intervals

    + Source: R/makeEVRfromDT.R +
    makeEVRfromDT.Rd
    +
    - - - +
    +

    This function generates Echoview Region definitions according to predefined starting and end depts at given times. +The results are save as .EVR file for import into Echoview

    +
    +
    +

    Usage

    + 
    makeEVRfromDT(
+  depths,
+  times,
+  dates,
+  rName = "Region",
+  rClass = "Selection",
+  rType = 1,
+  dir = NULL,
+  fn = NULL,
+  rNotes = list("")
+)
    +
    +
    +

    Arguments

    +
    depths
    +

    list of depths (can be multiple regions, where each is a list element)

    - - - +
    times
    +

    (character) list of times in HHMMSS

    +
    dates
    +

    list of dates as character %Y%m%d (can be multiple regions, where each is a list element)

    - - - - - - - - -
    -
    - - -
    +
    rClass
    +

    = "Selection". character Define class, otherwise it will be Unclassified

    -
    -
    -
    -

    Create an Echoview EVR (Region definition) file from depth and time intervals

    - Source: R/makeEVRfromDT.R - -
    -
    - -

    This function generates Echoview Region definitions according to predefined starting and end depts at given times. -The results are save as .EVR file for import into Echoview

    - -
    +
    rType
    +

    = 1 (integer; 0 to 4) see details

    - 
    makeEVRfromDT(depths, times, dates, rName = "Region",
-  rClass = "Selection", rType = 1, dir = NULL, fn = NULL,
-  rNotes = list(""))
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    depths

    list of depths (can be multiple regions, where each is a list element)

    times

    (character) list of times in HHMMSS

    dates

    list of dates as character %Y%m%d (can be multiple regions, where each is a list element)

    rName

    = "Region" (character) Name of the region

    rClass

    = "Selection". character Define class, otherwise it will be Unclassified

    rType

    = 1 (integer; 0 to 4) see details

    dir

    = NULL character Path to the output folder

    fn

    = NULL character Name of the output filename

    rNotes

    = list("") character Region Notes

    - -

    Value

    -

    saves an Echoview EVR (Region definition) files

    - -

    Details

    +
    dir
    +

    = NULL character Path to the output folder

    -

    The following region types (integer 0 to 4) are available in Echoview 0 - Bad Data (no data); 1 - Analysis; 2 - Marker; 3 - fishtracks; 4 - Bad Data (empty water)

    - -

    Note

    -

    This function is experimental

    - -

    See also

    +
    fn
    +

    = NULL character Name of the output filename

    -

    makeRectRegion

    - -

    Examples

    - 
    # NOT RUN {
-# Minimal example generating 2 regions
-depths <- list(c(10,35,50,74,82), c(15,250,300,350,60))
-times <-  list(c("090000","091000","091500","091000","090300"),
-               c("093000","094000","094500","094000","093300"))
-dates <- list(c(rep("20170901",5)),c(rep("20170901",5)))
-dir <- 'F:\\'
-fn <- 'imaginaryRegions'
-makeEVRfromDT(depths,times,dates,fn=fn,dir=dir)
-
-# }
    -
    -
    +
    +

    Value

    + -
  • See also
    • - -
  • Examples
    • - +

    saves an Echoview EVR (Region definition) files

    +
    +
    +

    Details

    +

    The following region types (integer 0 to 4) are available in Echoview 0 - Bad Data (no data); 1 - Analysis; 2 - Marker; 3 - fishtracks; 4 - Bad Data (empty water)

    +
    +
    +

    Note

    +

    This function is experimental

    +
    +
    +

    See also

    +

    makeRectRegion

    +
    +
    +

    Author

    +

    Sven Gastauer

    +
    -

    Author

    - -Sven Gastauer +
    +

    Examples

    + 
    if (FALSE) {
+# Minimal example generating 2 regions
+depths <- list(c(10,35,50,74,82), c(15,250,300,350,60))
+times <-  list(c("090000","091000","091500","091000","090300"),
+               c("093000","094000","094500","094000","093300"))
+dates <- list(c(rep("20170901",5)),c(rep("20170901",5)))
+dir <- 'F:\\'
+fn <- 'imaginaryRegions'
+makeEVRfromDT(depths,times,dates,fn=fn,dir=dir)
+ }
+
    +
    +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/makeRectRegion.html b/docs/reference/makeRectRegion.html index acc6daf..1fb3512 100644 --- a/docs/reference/makeRectRegion.html +++ b/docs/reference/makeRectRegion.html @@ -1,226 +1,163 @@ - - - - - - +Make a rectangular Echoview region (EVR) file. — makeRectRegion • EchoviewR + Skip to contents + -Make a rectangular Echoview region (EVR) file. — makeRectRegion • EchoviewR +
    +
    +
    +

    Make a rectangular Echoview region (EVR) file.

    + Source: R/makeRectRegion.R +
    makeRectRegion.Rd
    +
    - - - +
    +

    This function creates a rectangular (2D) Echoview region file. The function can add regions to an existing EVR file.

    +
    +
    +

    Usage

    + 
    makeRectRegion(
+  dateStart,
+  timeStart,
+  dateStop,
+  timeStop,
+  minDepth = 0,
+  maxDepth,
+  outPathFn,
+  regionClassName,
+  regionType,
+  append = FALSE,
+  exactRegionName = NULL
+)
    +
    +
    +

    Arguments

    +
    dateStart
    +

    date stamp for the start of the region (yyymmdd)

    - - - +
    timeStart
    +

    time stamp for the start of the region (hhmmss)

    +
    dateStop
    +

    date stamp for the end of the region (yyymmdd)

    - - - - - - - - -
    -
    - - -
    +
    minDepth
    +

    =0 Minimum depth for the region

    -
    -
    -
    -

    Make a rectangular Echoview region (EVR) file.

    - Source: R/makeRectRegion.R - -
    -
    - -

    This function creates a rectangular (2D) Echoview region file. The function can add regions to an existing EVR file.

    - -
    +
    maxDepth
    +

    maximum depth for the region

    - 
    makeRectRegion(dateStart, timeStart, dateStop, timeStop, minDepth = 0,
-  maxDepth, outPathFn, regionClassName, regionType, append = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    dateStart

    date stamp for the start of the region (yyymmdd)

    timeStart

    time stamp for the start of the region (hhmmss)

    dateStop

    date stamp for the end of the region (yyymmdd)

    timeStop

    time stamp for the end of the region (hhmmss)

    minDepth

    =0 Minimum depth for the region

    maxDepth

    maximum depth for the region

    outPathFn

    output parth and filename.

    regionClassName

    region class name

    regionType

    region Type (integer)

    append

    = FALSE should be region be added to the EVR file given in outPathFn

    - -

    Value

    -

    list: $msg messages from the function call $exportFLAG Boolean TRUE EVR file created or added. FALSE otherwise

    - -

    Details

    +
    outPathFn
    +

    output parth and filename.

    -

    Region types supported by Echoview: 0 = bad (no data); 1 = analysis; "2" = marker; 3 = fishtracks, and 4 = bad (empty water)

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - +
    regionClassName
    +

    region class name

    -

    Examples

    - 
    # NOT RUN {
-makeRectRegion(dateStart='20170815',timeStart='001525',
-dateStop='20170815',timeStop='001738',
-minDepth=20,maxDepth=100,
-outPathFn='~/test2.evr',
-regionClassName='ctd',append=FALSE)
-# }
    -
    - -
    +
    append
    +

    = FALSE should be region be added to the EVR file given in outPathFn

    + + +
    exactRegionName
    +

    = NULL exact region name (no integer increment will be applied)

    + +
    +
    +

    Value

    + -
    -
    +

    list: $msg messages from the function call $exportFLAG Boolean TRUE EVR file created or added. FALSE otherwise

    +
    +
    +

    Details

    +

    Region types supported by Echoview: 0 = bad (no data); 1 = analysis; "2" = marker; 3 = fishtracks, and 4 = bad (empty water)

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    + +
    +

    Examples

    + 
    if (FALSE) makeRectRegion(dateStart='20170815',timeStart='001525',
+dateStop='20170815',timeStop='001738', 
+minDepth=20,maxDepth=100,
+outPathFn='~/test2.evr',
+regionClassName='ctd',append=FALSE)
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    + + + - - + diff --git a/docs/reference/modifyECS.html b/docs/reference/modifyECS.html index eb924b4..37b3868 100644 --- a/docs/reference/modifyECS.html +++ b/docs/reference/modifyECS.html @@ -1,219 +1,145 @@ - - - - - - - -A function to modify Ex60/70 Echoview calibration files (ECS files) — modifyECS • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +A function to modify Ex60/70 Echoview calibration files (ECS files) — modifyECS • EchoviewR + Skip to contents + +
    -
    -
    -

    A function to modify Ex60/70 Echoview calibration files (ECS files)

    - Source: R/ECSFileEdit.R - +
    +

    A function to modify Ex60/70 Echoview calibration files (ECS files)

    + Source: R/ECSFileEdit.R +
    modifyECS.Rd
    -
    - +

    This function parses an EX60/70 Echoview calibration, finds a calibration parameter and changes its value.

    -
    - 
    modifyECS(ECSPathAndFile, ECStargetVar, NewValue, maxNlines = 200,
-  nBlanks2Stop = 4, FileNameSuffix)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ECSPathAndFile

    Echoview calibration path and filename (character)

    ECStargetVar

    Calibration parameter to change (character)

    NewValue

    Calibration values (numeric, vector)

    maxNlines

    = 200. Maximum number of lines in ECS file to search (numeric).

    nBlanks2Stop

    =4. Stop searching ECS file when this number of consecutive blanks has been encountered (numeric).

    FileNameSuffix

    filename suffix used to generate modified ECS file (character).

    - -

    Details

    +
    +

    Usage

    + 
    modifyECS(
+  ECSPathAndFile,
+  ECStargetVar,
+  NewValue,
+  maxNlines = 200,
+  nBlanks2Stop = 4,
+  ECSPathAndFileOut
+)
    +
    -

    This function can be used to modify parameters in an Echoview calibration file. The current form of the function is quite limited and we strongly recommend that users carefully check any resultant modified ECS files. Found instances of the target calibration parameter be retained by setting the corresponding element in the NewValue vector to NA.

    - -

    Note

    +
    +

    Arguments

    +
    ECSPathAndFile
    +

    Echoview calibration path and filename (character)

    -

    This function is under development and has only been tested on ECS files generated in the 'SimradEK60Raw' format and that include FILESET and SOURCECAL settings only

    -

    Currently the length of the NewValue parameter must equal the number of instances of the ECStargetVar found in the ECS file.

    - -

    References

    -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    +
    ECStargetVar
    +

    Calibration parameter to change (character)

    -

    EVAddCalibrationFile

    - -

    Examples

    - 
    # NOT RUN {
-ECSFile<-'/20120326_KAOS_SimradEK5.ecs'
-#change the absorption coefficient for the first frequency in 3-frequency EK60 data:
-modifyECS(ECSPathAndFile=ECSFile,ECStargetVar='AbsorptionCoefficient',NewValue=c(1,NA,NA),
-maxNlines=200,nBlanks2Stop=4,FileNameSuffix='alphaMod')
-#change sound speed in FILESET and the three frequencies in SOURCECAL:
-modifyECS(ECSPathAndFile=ECSFile,ECStargetVar='SoundSpeed',NewValue=rep(1500,4),
-         maxNlines=200,nBlanks2Stop=4,FileNameSuffix='sosMod')
-# }
    -
    - -
    +
    nBlanks2Stop
    +

    =4. Stop searching ECS file when this number of consecutive blanks has been encountered (numeric).

    -
    -
    + +
    ECSPathAndFileOut
    +

    Generated Echoview calibration path and filename (character).

    + +
    +
    +

    Details

    +

    This function can be used to modify parameters in an Echoview calibration file. The current form of the function is quite limited and we strongly recommend that users carefully check any resultant modified ECS files. Found instances of the target calibration parameter be retained by setting the corresponding element in the NewValue vector to NA.

    +
    +
    +

    Note

    +

    This function is under development and has only been tested on ECS files generated in the 'SimradEK60Raw' format and that include FILESET and SOURCECAL settings only

    +

    Currently the length of the NewValue parameter must equal the number of instances of the ECStargetVar found in the ECS file.

    +
    +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVAddCalibrationFile

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+ECSFile<-'/20120326_KAOS_SimradEK5.ecs'
+#change the absorption coefficient for the first frequency in 3-frequency EK60 data:
+modifyECS(ECSPathAndFile=ECSFile,ECStargetVar='AbsorptionCoefficient',NewValue=c(1,NA,NA),
+maxNlines=200,nBlanks2Stop=4,FileNameSuffix='alphaMod')
+#change sound speed in FILESET and the three frequencies in SOURCECAL:
+modifyECS(ECSPathAndFile=ECSFile,ECStargetVar='SoundSpeed',NewValue=rep(1500,4),
+         maxNlines=200,nBlanks2Stop=4,FileNameSuffix='sosMod')
+}
+
    +
    +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/msDATEConversion.html b/docs/reference/msDATEConversion.html index fc60078..9a0e2ab 100644 --- a/docs/reference/msDATEConversion.html +++ b/docs/reference/msDATEConversion.html @@ -1,173 +1,98 @@ - - - - - - - -Convert a Microsoft DATE object to a human readable date and time — msDATEConversion • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Convert a Microsoft DATE object to a human readable date and time — msDATEConversion • EchoviewR + Skip to contents + +
    -
    -
    -

    Convert a Microsoft DATE object to a human readable date and time

    - Source: R/msDATEConversion.R - +
    +

    Convert a Microsoft DATE object to a human readable date and time

    + Source: R/msDATEConversion.R +
    msDATEConversion.Rd
    -
    - +

    Time stamps in Echoview, such as start and end times of, for example, invididual regions, use the Microsoft DATE format. This function converts the Microsoft DATE object to a human readable date and time. NB no time zone is returned.

    -
    - 
    msDATEConversion(dateObj)
    - -

    Arguments

    - - - - - - -
    dateObj

    a Microsoft date object

    - -

    Value

    +
    +

    Usage

    + 
    msDATEConversion(dateObj)
    +
    -

    time stamp in the format yyyy-mm-dd hh:mm:ss

    - -

    See also

    +
    +

    Arguments

    +
    dateObj
    +

    a Microsoft date object

    -

    www.echoview.com

    +
    +
    +

    Value

    -
    - +
    +

    See also

    +

    www.echoview.com

    +
    -
  • See also
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/readUnderlyingDataCSV.html b/docs/reference/readUnderlyingDataCSV.html index 3616914..1125a34 100644 --- a/docs/reference/readUnderlyingDataCSV.html +++ b/docs/reference/readUnderlyingDataCSV.html @@ -1,209 +1,135 @@ - - - - - - +Read CSV resulting from a call of EVExportUnderlying() — readUnderlyingDataCSV • EchoviewR + Skip to contents + -Read CSV resulting from a call of EVExportUnderlying() — readUnderlyingDataCSV • EchoviewR +
    +
    +
    +

    Read CSV resulting from a call of EVExportUnderlying()

    + Source: R/readUnderlyingDataCSV.R +
    readUnderlyingDataCSV.Rd
    +
    - - - +
    +

    This function reads a CSV file created after a call of EVExportUnderlying(). The data can be Sv values or values from, for example, the Echoview formula operator.

    +
    +
    +

    Usage

    + 
    readUnderlyingDataCSV(
+  pathAndFn,
+  samplePreFix = "sample",
+  depthPreFix = "z",
+  asList = FALSE,
+  onlyHeader = FALSE,
+  lastHeaderCol = 13
+)
    +
    +
    +

    Arguments

    +
    pathAndFn
    +

    The path and filename of the CSV fileonlyHeader

    - - - +
    samplePreFix
    +

    ='sample' (character)text to add to the sample column names

    +
    depthPreFix
    +

    = 'z' (character) text to add to the sample row names (depth)

    - - - - - - - - -
    -
    - - -
    +
    onlyHeader
    +

    = FALSE (boolean) return only the header of the CSV, ignored if asList = TRUE. See details.

    -
    -
    -
    -

    Read CSV resulting from a call of EVExportUnderlying()

    - Source: R/readUnderlyingDataCSV.R - -
    - -
    - -

    This function reads a CSV file created after a call of EVExportUnderlying(). The data can be Sv values or values from, for example, the Echoview formula operator.

    - -
    - 
    readUnderlyingDataCSV(pathAndFn, samplePreFix = "sample",
-  depthPreFix = "z", asList = FALSE, onlyHeader = FALSE,
-  lastHeaderCol = 13)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    pathAndFn

    The path and filename of the CSV fileonlyHeader

    samplePreFix

    ='sample' (character)text to add to the sample column names

    depthPreFix

    = 'z' (character) text to add to the sample row names (depth)

    asList

    = FALSE (boolean) return the CSV as a list. See details.

    onlyHeader

    = FALSE (boolean) return only the header of the CSV, ignored if asList = TRUE. See details.

    lastHeaderCol

    = 13 The last column of the header information.

    - -

    Value

    +
    lastHeaderCol
    +

    = 13 The last column of the header information.

    -

    see details

    +
    +
    +

    Value

    -

    Details

    +

    see details

    +
    +
    +

    Details

    The default return option is a data.frame of ping header and sample information. If asList=TRUE a list with $header and $samples is returned, If onlyHeader=TRUE only the headerinformation is returned.

    - -

    References

    - -

    http://support.echoview.com/WebHelp/Echoview.htm/

    - -

    See also

    - -

    EVExportUnderlying

    - - -
    - +
    +

    References

    +

    http://support.echoview.com/WebHelp/Echoview.htm/

    +
    +
    +

    See also

    +

    EVExportUnderlying

    +
    -
  • See also
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/readevl2R.html b/docs/reference/readevl2R.html index bb7ee53..34f86df 100644 --- a/docs/reference/readevl2R.html +++ b/docs/reference/readevl2R.html @@ -1,173 +1,100 @@ - - - - - - - -Read and Echoview line (.evl) file into R — readevl2R • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Read and Echoview line (.evl) file into R — readevl2R • EchoviewR + Skip to contents + +
    -
    -
    -

    Read and Echoview line (.evl) file into R

    - Source: R/readevl2R.R - +
    +

    Read and Echoview line (.evl) file into R

    + Source: R/readevl2R.R +
    readevl2R.Rd
    -
    - +

    Read and Echoview line (.evl) file into R

    -
    - 
    readevl2R(pathFn, tz = "GMT")
    - -

    Arguments

    - - - - - - - - - - -
    pathFn

    path and filename of evl file

    tz

    ='GMT' time zone see as.POSIXlt

    +
    +

    Usage

    + 
    readevl2R(pathFn, tz = "GMT")
    +
    + +
    +

    Arguments

    +
    pathFn
    +

    path and filename of evl file

    + + +
    tz
    +

    ='GMT' time zone see as.POSIXlt

    + +
    +
    +

    Value

    -

    Value

    -

    list object of class evl: [1]$timing ($start, $end start and end time stamps); [2] $line1 line 1 - evl file first line; +

    list object of class evl: [1]$timing ($start, $end start and end time stamps); [2] $line1 line 1 - evl file first line; [3] $n number of points in evl file; [4] $bodyEVL body of evl file; [5] $timeStamp time stamp for; [6] msg message log;; [7] $pathFn path and filename of Echoview line file; [8] tz time zone

    - +
    -
    -
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/schoolRelativeDimension.html b/docs/reference/schoolRelativeDimension.html index 04dd15a..7881521 100644 --- a/docs/reference/schoolRelativeDimension.html +++ b/docs/reference/schoolRelativeDimension.html @@ -1,195 +1,118 @@ - - - - - - - -Calculate the relative dimension of a school — schoolRelativeDimension • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Calculate the relative dimension of a school — schoolRelativeDimension • EchoviewR + Skip to contents + +
    -
    -
    -

    Calculate the relative dimension of a school

    - Source: R/schoolRelativeDimension.R - +
    +

    Calculate the relative dimension of a school

    + Source: R/schoolRelativeDimension.R +
    schoolRelativeDimension.Rd
    -
    - +

    This function calculates the relative school dimension of Diner (2001)

    -
    - 
    schoolRelativeDimension(Sv, L, P, Th, theta)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    Sv

    Observed mean volume backscattering strength (Sv) of a school

    L

    Observed (uncorrected) school length, m

    P

    Mean depth of school

    Th

    Minimum Sv data threshold used to detect schools using the SHAPES algorithm

    theta

    Transducer 3 dB beam width, degrees

    - -

    Value

    +
    +

    Usage

    + 
    schoolRelativeDimension(Sv, L, P, Th, theta)
    +
    -

    Relative school dimension (Nb)

    - -

    References

    +
    +

    Arguments

    +
    Sv
    +

    Observed mean volume backscattering strength (Sv) of a school

    -

    Diner, N. (2001). Correction on school geometry and density: approach based on acoustic image simulation. Aquatic Living Resources, 14(4), 211-222.

    - -

    See also

    -

    EVSchoolsDetect EVIntegrationByRegionsExport

    - +
    L
    +

    Observed (uncorrected) school length, m

    -
    - -
    +
    Th
    +

    Minimum Sv data threshold used to detect schools using the SHAPES algorithm

    -
    -
    + +
    theta
    +

    Transducer 3 dB beam width, degrees

    + +
    +
    +

    Value

    + + +

    Relative school dimension (Nb)

    +
    +
    +

    References

    +

    Diner, N. (2001). Correction on school geometry and density: approach based on acoustic image simulation. Aquatic Living Resources, 14(4), 211-222.

    +
    +
    +

    See also

    +

    EVSchoolsDetect EVIntegrationByRegionsExport

    +
    + +
    + + +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/writeRevl2file.html b/docs/reference/writeRevl2file.html index 57d0a9b..a166a41 100644 --- a/docs/reference/writeRevl2file.html +++ b/docs/reference/writeRevl2file.html @@ -1,177 +1,102 @@ - - - - - - - -Write an Echoview line (.evl) file — writeRevl2file • EchoviewR - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Write an Echoview line (.evl) file — writeRevl2file • EchoviewR + Skip to contents + +
    -
    -
    -

    Write an Echoview line (.evl) file

    - Source: R/writeRevl2file.R - +
    +

    Write an Echoview line (.evl) file

    + Source: R/writeRevl2file.R +
    writeRevl2file.Rd
    -
    - +

    Write an Echoview line (.evl) file

    -
    - 
    writeRevl2file(evlObj, pathFn)
    - -

    Arguments

    - - - - - - - - - - -
    evlObj

    An R object of class 'evl' resulting from a call of readevl2R()

    pathFn

    path and filename of evl file to be create

    - -

    Value

    +
    +

    Usage

    + 
    writeRevl2file(evlObj, pathFn)
    +
    + +
    +

    Arguments

    +
    evlObj
    +

    An R object of class 'evl' resulting from a call of readevl2R()

    -

    list object: [1]$success; [2] msg message log

    - -

    See also

    -

    readevl2R

    +
    pathFn
    +

    path and filename of evl file to be create

    + +
    +
    +

    Value

    -
    - +
    +

    See also

    +

    readevl2R

    +
    -
  • See also
    • - +
    -
    -
    -
    -
    +

    Developed by Martin Cox, Sven Gastauer, Lisa-Marie Harrison.

    -
    -

    Site built with pkgdown.

    +
    +

    Site built with pkgdown 2.0.9.

    -
    -
    +
    + + - - + diff --git a/docs/reference/zigzagSurvey.html b/docs/reference/zigzagSurvey.html index 27bbd32..8a288c2 100644 --- a/docs/reference/zigzagSurvey.html +++ b/docs/reference/zigzagSurvey.html @@ -1,248 +1,183 @@ - - - - - - +Generate a coordinate list for a zig-zag survey — zigzagSurvey • EchoviewR + Skip to contents + -Generate a coordinate list for a zig-zag survey — zigzagSurvey • EchoviewR +
    +
    +
    +

    Generate a coordinate list for a zig-zag survey

    + Source: R/surveyPlanning.R +
    zigzagSurvey.Rd
    +
    - - - +
    +

    The coordinate list is generated in degrees decimal degree format (dd.ddd), with +Southern hemisphere denoted by negative numbers. Transect length are specified in km +and bearings in degress where North 0 deg, East 90 deg, South 180 deg and West 270 deg.

    +
    +
    +

    Usage

    + 
    zigzagSurvey(
+  startLon,
+  startLat,
+  lineLengthkm,
+  startBearingdeg,
+  rotationdeg,
+  numOfLines,
+  proj4string = CRS("+proj=longlat +datum=WGS84"),
+  unrotated = FALSE
+)
    +
    +
    +

    Arguments

    +
    startLon
    +

    start longitude of survey.

    - - - +
    startLat
    +

    start latitude of survey.

    +
    lineLengthkm
    +

    transect line length in km.

    - - - - - - - - -
    -
    - - -
    +
    rotationdeg
    +

    rotation angle for entire survey pattern.

    -
    -
    -
    -

    Generate a coordinate list for a zig-zag survey

    - Source: R/surveyPlanning.R - -
    -
    - -

    The coordinate list is generated in degrees decimal degree format (dd.ddd), with -Southern hemisphere denoted by negative numbers. Transect length are specified in km -and bearings in degress where North 0 deg, East 90 deg, South 180 deg and West 270 deg.

    - -
    +
    numOfLines
    +

    Number of transects.

    - 
    zigzagSurvey(startLon, startLat, lineLengthkm, startBearingdeg,
-  rotationdeg, numOfLines,
-  proj4string = CRS("+proj=longlat +datum=WGS84"), unrotated = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    startLon

    start longitude of survey.

    startLat

    start latitude of survey.

    lineLengthkm

    transect line length in km.

    startBearingdeg

    Bearing of each transect in degrees.

    rotationdeg

    rotation angle for entire survey pattern.

    numOfLines

    Number of transects.

    proj4string

    projection string of class CRS-class

    unrotated

    FALSE return rotated coordinates TRUE list of rotated and unrotated coordinates.

    - -

    Value

    -

    Geographical coordinates of start and end of line positions. unrotated=TRUE list of rotated and unrotated coordinates

    - -

    See also

    +
    proj4string
    +

    projection string of class CRS-class

    -

    zigzagSurvey

    - -

    Examples

    - 
    # NOT RUN {
-coords=zigzagSurvey(startLon=-100,startLat=-60,lineLengthkm=2,
-startBearingdeg=30,
-rotationdeg=10,numOfLines=11)
-plot(0,0,xlim=range(coords[,1]),ylim=range(coords[,2]),type='n',
-xlab='Longitude, deg',ylab='Latitude, deg')
-arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2],
-      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
-text(coords,row.names(coords),cex=0.6)
-points(coords[1,1],coords[1,2],col='blue',pch=17,cex=2)
-points(coords[nrow(coords),1],coords[nrow(coords),2],col='blue',pch=15,cex=2)
-legend('topright',c('Beginning','End'),col='blue',pch=c(17,15))
-#Use unrotated=TRUE and check coordinates in the- 
-#-returned coordinate list object are identical:
-coordL= zigzagSurvey(startLon=-100,startLat=-60,lineLengthkm=2,
-startBearingdeg=30,
-rotationdeg=0,numOfLines=11,unrotated=TRUE)
-identical(coordL[[1]],coordL[[2]])
-#display rotated and unrotated coordinates"
-coordL= zigzagSurvey(startLon=-100,startLat=-60,lineLengthkm=2,
-startBearingdeg=30,
-rotationdeg=5,numOfLines=11,unrotated=TRUE)
-coords=coordL$unrotatedGeogs; coordsRotate=coordL$rotatedGeogs
-plot(0,0,xlim=range(c(coords[,1],coordsRotate[,1])),
-ylim=range(c(coords[,2],coordsRotate[,2])),type='n',
-xlab='Longitude, deg',ylab='Latitude, deg')
-arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2],
-      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
-arrows(x0=coordsRotate[1:(nrow(coordsRotate)-1),1],
-y0=coordsRotate[1:(nrow(coordsRotate)-1),2],
-      x1 = coordsRotate[2:nrow(coordsRotate),1],
-      y1 = coordsRotate[2:nrow(coordsRotate),2],col='blue')
-legend('bottomleft',c('Unrotated','Rotated'),lty=1,col=c(1,'blue'))
-# }
    -
    -
    +
    +

    Value

    -Martin Cox martin.cox@aad.gov.au -
    -
    +

    Geographical coordinates of start and end of line positions. unrotated=TRUE list of rotated and unrotated coordinates

    +
    +
    +

    See also

    +

    zigzagSurvey

    +
    +
    +

    Author

    +

    Martin Cox martin.cox@aad.gov.au

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+coords=zigzagSurvey(startLon=-100,startLat=-60,lineLengthkm=2,
+startBearingdeg=30,
+rotationdeg=10,numOfLines=11)
+plot(0,0,xlim=range(coords[,1]),ylim=range(coords[,2]),type='n',
+xlab='Longitude, deg',ylab='Latitude, deg')
+arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2], 
+      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
+text(coords,row.names(coords),cex=0.6)
+points(coords[1,1],coords[1,2],col='blue',pch=17,cex=2)
+points(coords[nrow(coords),1],coords[nrow(coords),2],col='blue',pch=15,cex=2)
+legend('topright',c('Beginning','End'),col='blue',pch=c(17,15))
+#Use unrotated=TRUE and check coordinates in the- 
+#-returned coordinate list object are identical:
+coordL= zigzagSurvey(startLon=-100,startLat=-60,lineLengthkm=2,
+startBearingdeg=30,
+rotationdeg=0,numOfLines=11,unrotated=TRUE)
+identical(coordL[[1]],coordL[[2]])
+#display rotated and unrotated coordinates"
+coordL= zigzagSurvey(startLon=-100,startLat=-60,lineLengthkm=2,
+startBearingdeg=30,
+rotationdeg=5,numOfLines=11,unrotated=TRUE) 
+coords=coordL$unrotatedGeogs; coordsRotate=coordL$rotatedGeogs
+plot(0,0,xlim=range(c(coords[,1],coordsRotate[,1])),
+ylim=range(c(coords[,2],coordsRotate[,2])),type='n',
+xlab='Longitude, deg',ylab='Latitude, deg')
+arrows(x0=coords[1:(nrow(coords)-1),1], y0=coords[1:(nrow(coords)-1),2], 
+      x1 = coords[2:nrow(coords),1], y1 = coords[2:nrow(coords),2])
+arrows(x0=coordsRotate[1:(nrow(coordsRotate)-1),1], 
+y0=coordsRotate[1:(nrow(coordsRotate)-1),2], 
+      x1 = coordsRotate[2:nrow(coordsRotate),1], 
+      y1 = coordsRotate[2:nrow(coordsRotate),2],col='blue')
+legend('bottomleft',c('Unrotated','Rotated'),lty=1,col=c(1,'blue'))
+}
+
    +
    +
    - + + - - +