Introduction to artfishr

This vignette shows how to use artfishr.

Installation

The R artfishr can be installed from Github.

As prequirements, packages remotes and vrule should be installed.

• Package remotes can be installed from CRAN using:

install.packages("remotes", repos = "https://cloud.r-project.org")

## Installing package into '/home/runner/work/_temp/Library'
## (as 'lib' is unspecified)

• Package vrule should be installed from GitHub using remotes:

remotes::install_github("fdiwg/vrule")

## Using github PAT from envvar GITHUB_PAT. Use `gitcreds::gitcreds_set()` and unset GITHUB_PAT in .Renviron (or elsewhere) if you want to use the more secure git credential store instead.

## Skipping install of 'vrule' from a github remote, the SHA1 (37f9c2d0) has not changed since last install.
##   Use `force = TRUE` to force installation

Once packages remotes and vrule, R package artfishr can be installed using:

remotes::install_github("fdiwg/artfishr")

## Using github PAT from envvar GITHUB_PAT. Use `gitcreds::gitcreds_set()` and unset GITHUB_PAT in .Renviron (or elsewhere) if you want to use the more secure git credential store instead.

## Downloading GitHub repo fdiwg/artfishr@HEAD

## Rcpp    (1.1.1 -> 1.1.1-1) [CRAN]
## glue    (1.8.0 -> 1.8.1  ) [CRAN]
## openssl (2.3.5 -> 2.4.0  ) [CRAN]
## S7      (0.2.1 -> 0.2.1-1) [CRAN]

## Installing 4 packages: Rcpp, glue, openssl, S7

## Installing packages into '/home/runner/work/_temp/Library'
## (as 'lib' is unspecified)

## ── R CMD build ─────────────────────────────────────────────────────────────────
## * checking for file ‘/tmp/Rtmpg0ZY4b/remotes1c5422584167/fdiwg-artfishr-e1e5424/DESCRIPTION’ ... OK
## * preparing ‘artfishr’:
## * checking DESCRIPTION meta-information ... OK
## * checking for LF line-endings in source and make files and shell scripts
## * checking for empty or unneeded directories
## * building ‘artfishr_0.1.20260416.tar.gz’

## Installing package into '/home/runner/work/_temp/Library'
## (as 'lib' is unspecified)

Once installed, artfishr can be loaded using library(artfishr) or `require(artfishr)``

Data requirements

TODO

The Artfish methodology - summary

TODO

How to run Artfish with artfishr

TODO