Skip to contents

Overview

framrsquared is a library with a focus on easing the burden of working in the FRAM database by providing convenient methods to import tables into R, and producing similar analyses as the FRAM executable while extending it some circumstances. framrsquared is part of the FRAMverse R-Universe.

Installation

Note for WDFW employees

Our IT department is treating the default unzipping functionality of the pak package as a security risk. Either install the package with devtools::install_github() rather than pak::pkg_install() or set up R to use a fallback unzipping method when pak’s default fails. To do that, edit your .Rprofile file (e.g., with usethis::edit_r_profile()) to add the following line: R_ZIP_PROCESS_FALLBACK=true.

Instructions

framrsquared can be installed through R-Universe:

install.packages(c("framrsquared", "framrosetta"), repos = "https://framverse.r-universe.dev")

Otherwise, if you have Rtools and the devtools or remotes packages installed, framrsquared can be installed from source code:

devtools::install_github("FRAMverse/framrsquared")

# Alternatively, with `pak` installed
pak::pkg_install("FRAMverse/framrsquared")

To install the development version, which may include new features that have been added but may not be as thoroughly tested:

install.packages(c("framrsquared.dev", "framrosetta"), repos = "https://framverse.r-universe.dev")
## make sure `pak` is installed:
## install.packages("pak")
pak::pkg_install("FRAMverse/framrsquared@dev")

The development version will be installed as framrsquared.dev and can be used with library(framrsquared.dev) or the framrsquared.dev:: prefix.