-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
113 lines (78 loc) · 5.91 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
---
output:
github_document:
html_preview: TRUE
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
fig.asp = 2/3,
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# photobiology <img src="man/figures/logo.png" align="right" width="120"/>
<!-- badges: start -->
[](https://cran.r-project.org/package=photobiology) [](https://cran.r-project.org/web/checks/check_results_photobiology.html)
[](https://aphalo.r-universe.dev/photobiology)
[](https://github.com/aphalo/photobiology/actions)
[](https://docs.r4photobiology.info/photobiology/)
[](https://doi.org/10.32614/CRAN.package.photobiology)
<!-- badges: end -->
Package '**photobiology**' defines a system of classes for storing spectral data and accompanying metadata. For each of these classes specialised summary methods, maths operators and functions are provided. In addition, classes for storing collections of objects of the classes for individual spectra are defined as well as 'apply' functions. Extraction and replacement operators are implemented.
Functions for calculation of the position of the sun, times of sunrise and sunset, day length and night length are also available. Starting from 'photobiology' 0.12.0 they are imported from package 'SunCalcMeeus', which is a spin-off of 'photobiology. _If you only use these functions, you can attach or load 'SunCalcMeeus' instead of 'photobiology', otherwise, the only visible change is that the on-line help is at [a separate site](https://docs.r4photobiology.info/SunCalcMeeus/)._
Functions for the estimation of evapotranspiration and the energy balance of vegetation have been migrated to package ['photobiologyPlants'](https://docs.r4photobiology.info/photobiologyPlants/) as they are related to vegetation. To use them with this version of package 'photobiology', please, add `library(photobiologyPlants)` to your code.
The package supports storage and manipulation of data for radiation quantities and for optical properties of objects and solutes, as well as response and action spectra for photobiological, photochemical and photoelectrical responses.
This package is the core of a suite of R packages for photobiological calculations described at the [r4photobiology](https://www.r4photobiology.info) web site and in the vignette [The R for Photobiology Suite](https://docs.r4photobiology.info/photobiology/articles/userguide-0-r4p-introduction.html).
## Examples
The first example shows you how to estimate solar irradiance in W/m2 under a filter. We use a measured solar spectrum and a measured filter transmission spectrum.
```{r example1, message=FALSE}
library(photobiology)
e_irrad(sun.spct * yellow_gel.spct)
```
The second example shows some simple astronomical calculations for the sun.
```{r example2}
geocode <- data.frame(lon = 0, lat = 55)
date <- lubridate::now(tzone = "UTC")
sunrise_time(date, tz = "UTC", geocode = geocode)
day_length(date, tz = "UTC", geocode = geocode)
```
## Installation
Installation of the most recent stable version from CRAN:
```{r, eval=FALSE}
install.packages("photobiology")
```
Installation of the current unstable version from R-Universe CRAN-like repository:
```{r, eval=FALSE}
install.packages('photobiology',
repos = c('https://aphalo.r-universe.dev',
'https://cloud.r-project.org'))
```
Once package 'photobiology' is installed, installation of the remaining or missing packages in the suite from CRAN (or by adding the repository information as above, from R-Universe):
```{r, eval=FALSE}
intalled_pkgs <- installed.packages()[ , 1]
missing_pkgs <- setdiff(photobiology::r4p_pkgs, intalled_pkgs)
if (length(missing_pkgs) > 0) {
install.packages(missing_pkgs)
}
```
Installation of the current unstable version from GitHub:
```{r, eval=FALSE}
# install.packages("devtools")
devtools::install_github("aphalo/photobiology")
```
## Documentation
HTML documentation is available at (<https://docs.r4photobiology.info/photobiology/>), including three *User Guides*.
News on updates to the different packages of the 'r4photobiology' suite are regularly posted at (<https://www.r4photobiology.info/>).
Two articles introduce the basic ideas behind the design of the suite and describe its use: Aphalo P. J. (2015) (<https://doi.org/10.19232/uv4pb.2015.1.14>) and Aphalo P. J. (2016) (<https://doi.org/10.19232/uv4pb.2016.1.15>).
A book is under preparation, and the draft is currently available at (<https://leanpub.com/r4photobiology/>).
A handbook written before the suite was developed contains useful information on the quantification and manipulation of ultraviolet and visible radiation: Aphalo, P. J., Albert, A., Björn, L. O., McLeod, A. R., Robson, T. M., & Rosenqvist, E. (Eds.) (2012) Beyond the Visible: A handbook of best practice in plant UV photobiology (1st ed., p. xxx + 174). Helsinki: University of Helsinki, Department of Biosciences, Division of Plant Biology. ISBN 978-952-10-8363-1 (PDF), 978-952-10-8362-4 (paperback). PDF file available from (<https://hdl.handle.net/10138/37558>).
## Contributing
Pull requests, bug reports, and feature requests are welcome at (<https://github.com/aphalo/photobiology>).
## Citation
If you use this package to produce scientific or commercial publications, please cite according to:
```{r}
citation("photobiology")
```
## License
© 2012-2025 Pedro J. Aphalo ([pedro.aphalo\@helsinki.fi](mailto:[email protected]){.email}). Released under the GPL, version 2 or greater. This software carries no warranty of any kind.