| Title: | Find Out Who Maintains the Packages you Use |
|---|---|
| Description: | Find out who maintains the packages you use in your current session or in your package library and maybe say 'thank you'. |
| Authors: | Dirk Schumacher [aut, cre] |
| Maintainer: | Dirk Schumacher <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.0.0.9000 |
| Built: | 2024-11-21 03:03:56 UTC |
| Source: | https://github.com/dirkschumacher/thankr |
This function is meant to be used when developing a package.
It extracts all package dependencies from the DESCRIPTION file in your working directory
and checks if you have starred it on github (if those packages are hosted on github).
appreciate()appreciate()
Still under development. Api and names can change.
The function assumes that you have set an environment variable
(either GITHUB_PAT or GITHUB_TOKEN) with a Github Access Token.
When using this function together with shoulders please note that
once run for the first time additional packages are attached to your session.
Also take a look at the API documentation <https://developer.github.com/v3/> of Github and their terms of use before using this function.
Always returns an invisible data.frame with three columns "username", "repository" and "starred". Also outputs that information to the console.
Inspired by <https://github.com/musically-ut/appreciate>
Starring a package on Github is a form of appreciation for the project. With this function you can quickly check if you starred all your favorite packages.
gh_starred(packages, console_output = TRUE, api_url = "https://api.github.com", user_agent = "https://github.com/dirkschumacher/thankr")gh_starred(packages, console_output = TRUE, api_url = "https://api.github.com", user_agent = "https://github.com/dirkschumacher/thankr")
packages |
a non empty character vector of package names. |
console_output |
Optional. TRUE if the result should be written to the console |
api_url |
Optional. The GitHub API url. |
user_agent |
Optional. The user-agent for all the API requests. Change it if this function is part of something bigger. |
Still under development. Api and names can change.
The function assumes that you have set an environment variable
(either GITHUB_PAT or GITHUB_TOKEN) with a Github Access Token.
When using this function together with shoulders please note that
once run for the first time additional packages are attached to your session.
Also take a look at the API documentation <https://developer.github.com/v3/> of Github and their terms of use before using this function.
Always returns a data.frame with three columns "username", "repository" and "starred".
If console_output is TRUE, then the return value is invisible.
Inspired by <https://github.com/musically-ut/appreciate>
This function helps to identify what packages you depend on. It finds the maintainers and the number of packages they maintain.
shoulders(where = c("session", "library", "package"), package, include_dependencies = TRUE)shoulders(where = c("session", "library", "package"), package, include_dependencies = TRUE)
where |
either look in the current loaded "session", your whole "library" or for a specific "package" |
package |
if |
include_dependencies |
if |
Note, if you do a package lookup you connect to a CRAN mirror.
A data.frame showing all packages you depend on with these three columns:
maintainer The maintainer as in the DESCRIPTION file
no_packages The number of packages of that maintainer
packages A comma separated list of those packages
## Not run: # identifies the packages currently loaded in your session shoulders() # equal to shoulders("session") # shows all maintainers of your package library shoulders("library") # find out about a specific package # by default it lists all dependencies of that package as well shoulders("package", "utils", include_dependencies = FALSE) shoulders("package", "utils") ## End(Not run)## Not run: # identifies the packages currently loaded in your session shoulders() # equal to shoulders("session") # shows all maintainers of your package library shoulders("library") # find out about a specific package # by default it lists all dependencies of that package as well shoulders("package", "utils", include_dependencies = FALSE) shoulders("package", "utils") ## End(Not run)
Find out who maintains the packages you use in your current session or in your package library.
This package exposes a single function shoulders that helps
you identify the maintainers of your favorite packages.
> standing on the shoulders of giants