Skip to content
This repository has been archived by the owner on Sep 9, 2022. It is now read-only.

Commit

Permalink
added appveyor.yml file and added file name to rbuildignore, ropensci…
Browse files Browse the repository at this point in the history
…/docs_private#152
  • Loading branch information
sckott committed Aug 12, 2014
1 parent dcb21d9 commit 3c19d80
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 7 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Expand Up @@ -11,3 +11,4 @@ inst/vign/
vignettes/rbhl_vignette.md
vignettes/margins.sty
vignettes/cache/
^appveyor\.yml$
15 changes: 8 additions & 7 deletions README.md
Expand Up @@ -2,15 +2,16 @@ rbhl
====

[![Build Status](https://api.travis-ci.org/ropensci/rbhl.png)](https://travis-ci.org/ropensci/rbhl)
[![Build status](https://ci.appveyor.com/api/projects/status/ej5u9mdirg1yyteg/branch/master)](https://ci.appveyor.com/project/sckott/rbhl/branch/master)

`rbhl` is an R interface to the Biodiversity Heritage Library API.
`rbhl` is an R interface to the Biodiversity Heritage Library API.

## Info

Authentication:

* Get your Biodiversity Heritage Library API key [here](http://www.biodiversitylibrary.org/getapikey.aspx)
* Put your API in your .Rprofile file using e.g., `options(BioHerLibKey = "YOURBHLAPIKEY")`, and the functions within this package will be able to use your API key without you having to enter it every time you run a search.
* Put your API in your .Rprofile file using e.g., `options(BioHerLibKey = "YOURBHLAPIKEY")`, and the functions within this package will be able to use your API key without you having to enter it every time you run a search.

Documentation:

Expand Down Expand Up @@ -56,7 +57,7 @@ Or get a list. The default output is a list, and if you set `format='xml'` and `

```coffee
bhl_authorsearch(name='dimmock', format='xml', output="list")
```
```

```coffee
$Status
Expand All @@ -75,13 +76,13 @@ $Result[[1]]$Name

$Result[[1]]$Role
NULL
```
```

Is the same output as all default options

```coffee
bhl_authorsearch(name='dimmock')
```
```

```coffee
$Status
Expand All @@ -102,7 +103,7 @@ $Result[[1]]$Role
NULL

[... cutoff]
```
```

### Some examples of function calls

Expand Down Expand Up @@ -242,4 +243,4 @@ A BibTeX entry for LaTeX users is

Get citation information for `rbhl` in R doing `citation(package = 'rbhl')`

[![](http://ropensci.org/public_images/github_footer.png)](http://ropensci.org)
[![](http://ropensci.org/public_images/github_footer.png)](http://ropensci.org)
23 changes: 23 additions & 0 deletions appveyor.yml
@@ -0,0 +1,23 @@
init:
ps: |
$ErrorActionPreference = "Stop"
Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1"
Import-Module '..\appveyor-tool.ps1'
install:
ps: Bootstrap

build_script:
- travis-tool.sh install_deps

test_script:
- travis-tool.sh run_tests

on_failure:
- travis-tool.sh dump_logs

notifications:
- provider: Slack
auth_token:
secure: S3AcHEoJHUtahR5N8ConStS8oV/+x34tS1bDGM3OD0QxDKBBxufeiMmXQsId1gZu
channel: package-development

0 comments on commit 3c19d80

Please sign in to comment.