CONTRIBUTING.md

In octopize/avatar-r: R Interface for Octopize's Avatarization Engine

How to contribute ?

This is a guide intended for developers wanting to lend a hand. It contains detailed instructions on how to setup your development environment and the prerequisites needed to work on this project.

Prerequisites

Make sure you have R installed. On macOS:

# libgit2 is required by devtools
brew install r libgit2
brew install --cask rstudio  # recommended

R --version  # make sure you have 4.1.2, the latest as of writing

If you have never created an R package before, it is good idea to follow the tutorial here: https://r-pkgs.org/whole-game.html

Installing deps

make install

Make sure things are properly installed:

> library(devtools)
Loading required package: usethis
> has_devel()
Your system is ready to build packages!

Quickstart

Install with:

# type="source" prevents a warning about R version
install.packages("...", repos=NULL, type="source")

See vignettes/tutorial.Rmd

If you make modifications to the library, you need to reload it with:

devtools::load_all()

RStudio is pretty useful for some stuff - its installation is recommended.

Checking the documentation

After having installed the current library:

help(set_server)
browseVignettes(package="avatar")

Generate a PDF tutorial

• Uncomment "output: pdf_document" and "always_allow_html: true", comment "output: rmarkdown::html_vignette".
• Open tutorial.Rmd in RStudio
• Knit the tutorial vignette

Releasing a new version

1. Run make lci to update the docs and tutorial.
2. Update version in DESCRIPTION
3. git add DESCRIPTION
4. git commit -m "chore: release $VERSION"
5. git tag -as $VERSION -m "Release version $VERSION"
6. git push --tags && git push

A GitHub action will then take care of checking the source code and creating a release.

Useful resources

• httr and curl
• Upload data directly from R session
• https://github.com/jeroen/curl/blob/master/R/form.R
• Writing an R package
• https://kbroman.org/pkg_primer/

octopize/avatar-r documentation built on March 23, 2024, 1:41 p.m.