# ------------------------------------------------
# CITATION.cff file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# ------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "luxR" in publications use:'
type: software
license: GPL-3.0-or-later
title: 'luxR: Underwater Light Analysis and Visual Ecology'
version: 0.1.1
identifiers:
- type: doi
  value: 10.32614/CRAN.package.luxR
abstract: 'Tools for quantifying and modelling underwater light environments. Propagates
  spectral irradiance through the water column via Beer-Lambert attenuation, computes
  photosynthetically active radiation (PAR), and converts between energy and photon-flux
  units. Provides the ''lux_spectrum'' S3 class for unit-safe spectral arithmetic
  and format readers for TriOS RAMSES and Ocean Optics instruments. The optional ''lightr''
  package parses further instrument formats into strict native records; explicit measurement,
  scale, calibration, and resampling policies govern conversion via read_spectrum().
  Spectra convert to and from the generic spectral classes of the optional ''photobiology''
  package, which also serves as the reference implementation luxR''s integration and
  photometry are validated against. Includes visual ecology utilities: Govardovskii
  (2000) visual-pigment templates, photoreceptor quantum catch, Vorobyev-Osorio colour
  discrimination (JND), Secchi depth, and explicitly unvalidated contrast-threshold
  distance scenarios.'
authors:
- family-names: Kirwan
  given-names: John D
  email: jkirwan+luxR@pm.me
preferred-citation:
  type: manual
  title: 'luxR: Underwater Light Analysis and Visual Ecology'
  authors:
  - family-names: Kirwan
    given-names: John D
    email: jkirwan+luxR@pm.me
  year: '2026'
  notes: R package version 0.1.1
  url: https://github.com/JohnKirwan/luxR
repository: https://johnkirwan.r-universe.dev
repository-code: https://github.com/JohnKirwan/luxR
commit: 75ae5c201a47cf658f3ea43bb9ef75689be01158
url: https://johnkirwan.github.io/luxR/
date-released: '2026-07-29'
contact:
- family-names: Kirwan
  given-names: John D
  email: jkirwan+luxR@pm.me