README.md

In davidclarance/rabm: An interface to the Africa Bird Atlas API

rabm

The rabm package provides an interface in R to the Africa Bird Atlas API.

The Africa Bird Atlas is based out of the University Of Cape Town and is funded by the FitzPatrick Institute of African Ornithology and the South African National Biodiversity Institute. The project is actively supported by BirdLife South Africa and BirdLasser.

Installing the package

The package is in development and therefore isn't hosted on CRAN. Therefore, the regular install.packages() technique will not work. To install the packages please follow the steps outlined below.

Step 1: Install devtools

install.packages("devtools")

Step 2: Install rabm by running the following code:

devtools::install_github("davidclarance/rabm")

You only need to do Step 1 and Step 2 once on your computer.

Step 3: Load the library

library(rabm)

You'll need to do Step 3 every time you use the library.

Using the package

Please read through the extracting data vignette here to learn how to extract data.

Getting help

If you're stuck please go through the following steps:

1. Use the ?: In your R terminal, you can do ?extract_all to get help with the extract_all function.

2. Read the documentation here.

3. Read through the case studies here

4. Contact the package developer David Clarance

davidclarance/rabm documentation built on Nov. 4, 2019, 9:44 a.m.