Merge pull request #60 from GlobalFishingWatch/develop

Merge develop to main prior to initial release

.Rbuildignore

@@ -1,3 +1,4 @@
 ^gfwr\.Rproj$
 ^\.Rproj\.user$
 ^README\.Rmd$
+^LICENSE\.md$

CodeOfConduct.md

@@ -0,0 +1,122 @@
+## Code of conduct
+
+
+### Our pledge
+
+We as members, contributors, and leaders pledge to make participation in the `gfwr` contributing
+and users community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+
+### Our standards
+
+Examples of behavior that contributes to a positive environment for the 
+community include:
+
+* Demonstrating empathy and kindness toward other people.
+* Being respectful of differing opinions, viewpoints, and experiences.
+* Giving and gracefully accepting constructive feedback.
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
+* Focusing on what is best not just for us as individuals, but for the overall community.
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind.
+* Trolling, insulting or derogatory comments, and personal or political attacks.
+* Public or private harassment.
+* Publishing others' private information, such as a physical or email address, without their explicit permission.
+* Other conduct which could reasonably be considered inappropriate in a professional setting.
+
+
+### Enforcement responsibilities
+
+The `gfwr` maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+The 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+
+### Scope
+
+This Code of Conduct applies within all `gfwr` community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing the `gfwr` community include using an official `gfwr` e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the `gfwr` package maintainers either publicly by
+[opening an issue](https://github.com/GlobalFishingWatch/gfwr/issues) in the `gfwr`
+repository or privately by e-mail to any maintainer (emails in the DESCRIPTION file 
+of the package), e.g., if needed for reporting unacceptable behavior of another maintainer).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All maintainers are obligated to respect the privacy and security of the
+reporter of any incident.
+
+
+### Enforcement guidelines
+
+The maintainers will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+**1. Correction**
+
+_Community impact:_ Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+_Consequence:_ A private, written warning from the maintainers, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+**2. Warning**
+
+_Community impact:_ A violation through a single incident or series of actions.
+
+_Consequence:_ A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+
+**3. Temporary ban**
+
+_Community impact:_ A serious violation of community standards, including
+sustained inappropriate behavior.
+
+_Consequence:_ A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+**4. Permanent ban**
+
+_Community impact:_ Demonstrating a pattern of violation of community standards,
+including sustained inappropriate behavior, harassment of an individual, or
+aggression toward or disparagement of classes of individuals.
+
+_Consequence:_ A permanent ban from any sort of public interaction within the
+`gfwr` community.
+
+
+### Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1,
+available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.

Contributing.md

@@ -0,0 +1,95 @@
+# Contributing
+
+(This contributing guide is an adaptation of the [Carpentries](https://github.com/carpentries-incubator/git-Rstudio-course/blob/gh-pages/CONTRIBUTING.md),
+[tidyverse](https://github.com/tidyverse/tidyverse.org/blob/main/content/contribute/index.md), and
+[unifr](https://github.com/ropensci/unifir/blob/HEAD/.github/CONTRIBUTING.md) contributing guides.)
+
+`gfwr` is an open source project,
+and we welcome contributions of multiple kinds:
+bug reports, 
+fixes to bugs,
+typos,
+improvements to documentation, 
+new functions.
+
+## Contributor Agreement
+
+By contributing,
+you agree that we may redistribute your work under [our license](LICENSE.md).
+In exchange,
+we will address your issues and/or assess your change proposal as promptly as we can,
+and help you become a member of our community.
+Everyone involved in `gfwr` 
+agrees to abide by our [code of conduct](CodeOfConduct.md).
+
+## How to Contribute
+
+The easiest way to get started is to file an issue
+to tell us about a spelling mistake,
+some awkward wording,
+or a bug.
+
+1.  If you do not have a [GitHub](https://github.com) account,
+    you can send us comments by email (see our emails in the [DESCRIPTION file](DESCRIPTION)).
+    However,
+    we will be able to respond more quickly if you use one of the other methods described below.
+
+2.  If you have a [GitHub](https://github.com) account,
+    or are willing to [create one](https://github.com/join),
+    but do not know how to use Git,
+    you can report problems or suggest improvements by [creating an issue](https://github.com/GlobalFishingWatch/gfwr/issues).
+    This allows us to assign the item to someone
+    and to respond to it in a threaded discussion.
+
+3.  If you are comfortable with Git,
+    and would like to add or change material,
+    you can submit a pull request (PR).
+
+Our preferred options are 3, 2, and 1, in that order.
+
+## What to Contribute
+
+### Fixing typos
+
+You can fix typos, spelling mistakes, or grammatical errors in the documentation directly with a PR. 
+This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file. 
+You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.
+
+If the PR is too complicated, you can use options 1 or 2 in the [previous section](#how-to-contribute)
+
+### Improvements to documentation
+
+You may think that some functions are not clear enough and have suggestions to 
+improve the documentation of the package. Here you'll also need to edit 
+[roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R` 
+file, in case you go for a PR.
+
+### Bug reports
+
+If you've found a bug, first create a minimal [reprex](/help#reprex). Spend some time trying to make it as minimal as possible: the more time you spend doing this, the easier it will be for the `gfwr` team to fix it. Then file an issue. If you can't reproduce the bug, it will be very difficult for us to fix it.
+
+### Fixes to bugs
+
+If you see a bug report in an issue and know how to fix it, please share your solution in the issue.
+If you can do a PR that would fix the issue, please do so and let us know in the issue. 
+
+### New functions
+
+The `gfwr` package has been developed to help the R community access GFW data for
+research and other applications. If you have ideas of new functions that are consistent 
+with this aim, please let us know through email, an issue, or a proposal with a PR. 
+If you would like to write the function but prefer to chat about it first with us,
+you can open an issue and start the conversation before doing a PR. 
+
+
+## What *Not* to Contribute
+
+Remember that this package is a wrapper for an API, so we do not intend to add
+functions to plot or analyze data. That would be out of the scope of the package.
+
+If you are interested in collaborating with us to generate such a package, please get in touch.
+Otherwise, you are welcome to create a package with functions out of the scope of
+this one by yourself. 
+We are happy to see other people making contributions for the community based on our work. 
+
+

DESCRIPTION

@@ -12,10 +12,10 @@ Authors@R: c(
           comment = c(ORCID = "YOUR-ORCID-ID"))      
     )
 Description: This package connects to several Global Fishing Watch APIs to get vessel and events information in an R-friendly format.
-License: GPL (>= 3)
+License: Apache License (>= 2)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.0
 Imports: 
     magrittr,
     dplyr,
@@ -26,6 +26,7 @@ Imports:
     tibble,
     tidyr,
     tidyselect,
+    progress,
     rjson
 Suggests:
     glue

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Global Fishing Watch
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.