Skip to content

Commit

Permalink
add onboarding badge and re-knit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cboettig committed Jul 21, 2017
1 parent a1418a4 commit 308b6b3
Show file tree
Hide file tree
Showing 2 changed files with 174 additions and 237 deletions.
2 changes: 1 addition & 1 deletion README.Rmd
Expand Up @@ -12,7 +12,7 @@ output:

[![Build Status](https://travis-ci.org/ropensci/rfishbase.svg?branch=rfishbase2.0)](https://travis-ci.org/ropensci/rfishbase) [![Coverage Status](https://coveralls.io/repos/ropensci/rfishbase/badge.svg?branch=rfishbase2.0)](https://coveralls.io/r/ropensci/rfishbase?branch=rfishbase2.0)
[![Downloads](http://cranlogs.r-pkg.org/badges/rfishbase)](https://github.com/metacran/cranlogs.app)

[![Onbaroding](https://ropensci.org/badges/137_status.svg)](https://github.com/ropensci/onboarding/issues/137)


Welcome to `rfishbase 2.0`. This package is a ground-up rewrite of the original `rfishbase` package described in [Boettiger et al. (2012)](http://www.carlboettiger.info/assets/files/pubs/10.1111/j.1095-8649.2012.03464.x.pdf), and is not backwards compatible with the original. The first version of `rfishbase` relied on the XML summary pages provided by FishBase, which contained relatively incomplete data and have since been deprecated. The package later added functions that relied on HTML scraping of fishbase.org, which was always slow, subject to server instabilities, and carried a greater risk of errors. To address all of these issues, we have now created a stand-alone FishBase API with the blessing of the FishBase.org team, who have kindly provided copies of the backend SQL database to our team for this purpose. At this time the API does not cover all tables provided by the SQL backend, but does access the largest and most commonly used. A list of all tables available from the API (and from rfishbase) can be seen using the `heartbeat()` function.
Expand Down

0 comments on commit 308b6b3

Please sign in to comment.