/
README.rmd
32 lines (24 loc) · 1023 Bytes
/
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
---
output:
md_document:
variant: markdown_github
---
<!-- README.md is generated from README.rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
This package is designed to help members of the [Kluane Red Squirrel Project](http://redsquirrel.biology.ualberta.ca/) work with the squirrel database in R. It provides functions encapsulating common database queries and helper functions to aid users writing their own bespoke queries. In all cases, the functions return database records in the form of R data frames ready for use in further analyses. This package requires access to the KRSP database and is therefore only of use to members of the project.
# Installation
```{r install, eval=F}
install.packages("devtools")
devtools::install_github("KluaneRedSquirrelProject/krsp")
```
# Use
For a full demonstation of the functions in this package consult the vignette.
```{r vignette, eval=F}
browseVignettes("krsp")
```