Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 8.66 KB

README.md

File metadata and controls

88 lines (55 loc) · 8.66 KB
Raw

gitlab

CRAN Status

Allows to conveniently work with GitLab’s v4 RESTful API from R. GitLab is an open-source DevOps software suite that i.a. includes a powerful Git forge.

In contrast to the gitlabr package, this package is built upon httr2 and features a thoroughly designed api_req() core function that easily allows to implement the RESTful API like it’s meant to be used, including light-weight (“cached”) requests etc. The package is designed in a purely functional way1. However, note that gitlabr still covers many more API endpoints than this package.

Documentation

Netlify Status

The documentation of this package is found here.

Installation

To install the latest development version of gitlab, run the following in R:

if (!("remotes" %in% rownames(installed.packages()))) {
  install.packages(pkgs = "remotes",
                   repos = "https://cloud.r-project.org/")
}

remotes::install_gitlab(repo = "rpkg.dev/gitlab")

Package configuration

Some of gitlab’s functionality is controlled via package-specific global configuration which can either be set via R options or environment variables (the former take precedence). This configuration includes:

::: table-wide

Description R option Environment variable Default value
Base URL of the GitLab v4 RESTful API server to be accessed when base_url is not explicitly provided to the functions of this package. gitlab.base_url R_GITLAB_BASE_URL "https://gitlab.com/api/v4"
GitLab project identifier to use when id_project is not explicitly provided to the functions of this package. gitlab.id_project R_GITLAB_ID_PROJECT
GitLab access token used for authentication when token is not explicitly provided to the functions of this package. A personal access token for gitlab.com can be created under this link. gitlab.token R_GITLAB_TOKEN Sys.getenv("GITLAB_COM_TOKEN")
:::

Development

R Markdown format

This package’s source code is written in the R Markdown file format to facilitate practices commonly referred to as literate programming. It allows the actual code to be freely mixed with explanatory and supplementary information in expressive Markdown format instead of having to rely on # comments only.

All the .gen.R suffixed R source code found under R/ is generated from the respective R Markdown counterparts under Rmd/ using pkgpurl::purl_rmd()2. Always make changes only to the .Rmd files – never the .R files – and then run pkgpurl::purl_rmd() to regenerate the R source files.

Coding style

This package borrows a lot of the Tidyverse design philosophies. The R code adheres to the principles specified in the Tidyverse Design Guide wherever possible and is formatted according to the Tidyverse Style Guide (TSG) with the following exceptions:

  • Line width is limited to 160 characters, double the limit proposed by the TSG (80 characters is ridiculously little given today’s high-resolution wide screen monitors).

    Furthermore, the preferred style for breaking long lines differs. Instead of wrapping directly after an expression’s opening bracket as suggested by the TSG, we prefer two fewer line breaks and indent subsequent lines within the expression by its opening bracket:

    # TSG proposes this
do_something_very_complicated(
  something = "that",
  requires = many,
  arguments = "some of which may be long"
)

# we prefer this
do_something_very_complicated(something = "that",
                              requires = many,
                              arguments = "some of which may be long")

    This results in less vertical and more horizontal spread of the code and better readability in pipes.

  • Usage of magrittr’s compound assignment pipe-operator %<>% is desirable3.

  • Usage of R’s right-hand assignment operator -> is not allowed4.

  • R source code is not split over several files as suggested by the TSG but instead is (as far as possible) kept in the single file Rmd/gitlab.Rmd which is well-structured thanks to its Markdown support.

As far as possible, these deviations from the TSG plus some additional restrictions are formally specified in pkgpurl::default_linters, which is (by default) used in pkgpurl::lint_rmd(), which in turn is the recommended way to lint this package.

Footnotes

  1. Thanks to pal’s canonicalized way to package configuration, setting necessary state globally like the API’s base URL and access token is still easy for users and transparent for developers. ↩

  2. The very idea to leverage the R Markdown format to author R packages was originally proposed by Yihui Xie. See his excellent blog post for his point of view on the advantages of literate programming techniques and some practical examples. Note that using pkgpurl::purl_rmd() is a less cumbersome alternative to the Makefile approach outlined by him. ↩

  3. The TSG explicitly instructs to avoid this operator – presumably because it’s relatively unknown and therefore might be confused with the forward pipe operator %>% when skimming code only briefly. I don’t consider this to be an actual issue since there aren’t many sensible usage patterns of %>% at the beginning of a pipe sequence inside a function – I can only think of creating side effects and relying on R’s implicit return of the last evaluated expression. Therefore – and because I really like the %<>% operator – it’s usage is welcome. ↩

  4. The TSG explicitly accepts -> for assignments at the end of a pipe sequence while Google’s R Style Guide considers this bad practice because it “makes it harder to see in code where an object is defined”. I second the latter. ↩