Index of /web/packages/CruzPlot/readme

[ICO]NameLast modifiedSizeDescription
[PARENTDIR]Parent Directory  -  
[TXT]README.html2020-09-07 10:30 7.7K 
README

CruzPlot

Travis build status AppVeyor build status

CruzPlot is an R package that contains a GUI for creating maps, plotting data, and performing basic data summaries from data files in the “DAS” format produced by WinCruz.

Installation

You can install CruzPlot from GitHub with:

# install.packages("remotes") # Install remotes package if needed
remotes::install_github("smwoodman/swfscDAS", build_vignettes = TRUE)
remotes::install_github("smwoodman/CruzPlot")

Note that CruzPlot depends on swfscDAS, and thus you should ensure that swfscDAS is installed and updated as well. Running the above code will ensure the latest versions of both packages are installed. However, if you want to force an installation, you can run:

remotes::install_github("smwoodman/swfscDAS", force = TRUE, build_vignettes = TRUE)
remotes::install_github("smwoodman/CruzPlot", force = TRUE)

Before installing CruzPlot, you must have R, RStudio, and the appropriate version of Rtools installed. It is best practice to install after closing all instances of R and RStudio, and then running the install code from the R GUI rather than RStudio. Please contact the developer if you have any issues.

After updating, it is recommended to create and save new workspaces, rather than using workspaces saved with a previous version of CruzPlot.

Running CruzPlot

To open and run CruzPlot, run the following code in RStudio:

CruzPlot::cruzplot_gui()

If text or images overlap within the CruzPlot window, you can make the browser window full screen or adjust the text size in your browser (e.g., Ctrl - minus (‘-’) on Windows systems)

CruzPlot manual

The CruzPlot manual can be downloaded at this link, or accessed when running CruzPlot by opening the “CruzPlot Manual” page. It is recommended for new users to read the first two pages of the manual for orientation purposes; the rest of the manual contains section-specific information (formatting requirements, etc.) and can be read on an as-needed basis.