We as members, contributors, and leaders pledge to make participation in our 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.
+Examples of behavior that contributes to a positive environment for our community include:
+Examples of unacceptable behavior include:
+Community leaders 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.
+Community leaders 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.
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at nicolas.casajus@fondationbiodiversite.fr. All complaints will be reviewed and investigated promptly and fairly.
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+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.
+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.
+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 community.
+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.
+Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+First off, thanks for taking the time to contribute!
+All types of contributions are encouraged and valued. See the Table of contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved.
+ +This project is released with a Contributor Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to nicolas.casajus@fondationbiodiversite.fr.
+We use the Tidyverse style guide for writing R code. Functions are documented with the roxygen2 syntax. rwosstarter uses the lower_snake_case.
If you want to contribute by commiting changes, please try to use the Conventional commits specification.
+Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+sessionInfo()).We will then take care of the issue as soon as possible.
+A good bug report shouldn’t leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+rwosstarter.We use GitHub Issues to track bugs and errors. If you run into an issue with the project:
+We will then take care of the issue as soon as possible.
+rwosstarter.Feature requests are tracked as GitHub Issues.
+rwosstarter users.We will then take care of the issue as soon as possible.
+We use the GitHub flow to collaborate on this project:
+git clone fork-url (replace fork-url by the URL of your fork). Alternatively, open RStudio IDE and create a New Project from Version Control.git checkout -b branch-name (replace branch-name by the name of your new branch).git add) and commit (git commit) your changes as often as necessarygit push origin branch-name.We will then review the PR as soon as possible.
+If you want to contribute by improving the README, please edit the README.Rmd (not the README.md). Do not forget to update the README.md by running:
+rmarkdown::render("README.Rmd")If you want to contribute by editing an existing vignette, just edit the corresponding Rmd file stored in the vignettes/ folder.
If you want to contribute by adding a new vignette, create a new Rmd in the vignettes/ folder and add the following header:
---
+title: "Vignette Title"
+output: rmarkdown::html_vignette
+vignette: >
+ %\VignetteIndexEntry{Vignette Title}
+ %\VignetteEngine{knitr::rmarkdown}
+ %\VignetteEncoding{UTF-8}
+---If you use a new external dependency, do not forget to add it in the DESCRIPTION file under the section Suggests (only if this package is not already listed under the tag Imports).
Check the integrity of the package with:
+
+devtools::check()If you want to contribute by improving the documentation of a function, open the corresponding file in the R/ folder and edit lines starting with #' (roxygen2 syntax).
Update the documentation (Rd files in the man/ folder) by running:
+devtools::document()If you use a new external dependency in the example section, do not forget to add it in the DESCRIPTION file under the section Imports (only if this package is not already listed).
Check the integrity of the package with:
+
+devtools::check()If you want to contribute by improving the code of a function, open and edit the corresponding file in the R/ folder.
Check the integrity of the package with:
+
+devtools::check()Do not forget to adapt the unit tests for the function by editing the corresponding file stored in the tests/testthat/ folder. We use the package testthat to implement unit tests.
Check your tests by running:
+
+devtools::test()If you want to contribute by submitting a new feature, please follow this workflow:
+R file in the folder R/.DESCRIPTION file.devtools::document().R file in the folder tests/testthat/.devtools::check().
+• Overview
• Requirements
• Installation
• Get started
• Citation
• Contributing
• Acknowledgments
+
The R package rwosstarter is a client to the Web of Science Starter API. It is dedicated to retrieve metadata (including times-cited counts) of scientific publications matching search terms. It can be used to run a literature synthesis.
rwosstarter is freely released by the FRB-CESAB.
All types of contributions are encouraged and valued. For more information, check out our Contributor Guidelines.
+Please note that the rwosstarter project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
Please note that the rwosstarter project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
The author of this project would like to thank Clarivate for giving access to the Starter API.