Skip to content

Commit

Permalink
add code of conduct (suggested in #49)
Browse files Browse the repository at this point in the history
  • Loading branch information
cboettig committed Jul 21, 2015
1 parent 66a8724 commit e7692f8
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 350 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ circle.yml
^data-raw$
^README\.Rmd$
^README-*\.png$
^CONDUCT\.md$
25 changes: 25 additions & 0 deletions CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http:contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
12 changes: 5 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,6 @@ Most tables contain many fields. To avoid overly cluttering the screen, `rfishba
species(fish, fields=c("SpecCode", "PriceCateg", "Vulnerability"))
```

Note that we also request `SpecCode`, the species code which uniquely identifies the species. Almost all tables include a field for `SpecCode`, which can be useful for joining these results with other tables later. The `SpecCode`s can always be converted into species names using the `speciesnames()` function. Here we add a column with the corresponding species name:

```{r}
data <- species(fish, fields=c("SpecCode", "PriceCateg", "Vulnerability"))
data <- cbind(species = speciesnames(data$SpecCode), data)
```

Unfortunately identifying what fields come from which tables is often a challenge. Each summary page on fishbase.org includes a list of additional tables with more information about species ecology, diet, occurrences, and many other things. `rfishbase` provides functions that correspond to most of these tables. Because `rfishbase` accesses the back end database, it does not always line up with the web display. Frequently `rfishbase` functions will return more information than is available on the web versions of the these tables. Some information found on the summary homepage for a species is not available from the `summary` function, but must be extracted from a different table, such as the species `Resilience`, which appears on the `stocks` table. Working in R, it is easy to query this additional table and combine the results with the data we have collected so far:


Expand All @@ -106,6 +99,11 @@ merge(data, resil)
```


-----------

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.


[![ropensci_footer](http://ropensci.org/public_images/github_footer.png)](http://ropensci.org)


Loading

0 comments on commit e7692f8

Please sign in to comment.