diff --git a/methodshub.qmd b/methodshub.qmd index 8d8153d..f2e7737 100644 --- a/methodshub.qmd +++ b/methodshub.qmd @@ -1,14 +1,40 @@ --- -title: rang - Reconstructing Reproducible R Computational Environments format: html: embed-resources: true gfm: default --- -## Description +# rang - Reconstructing Reproducible R Computational Environments + - +## Description + Resolve the dependency graph of R packages at a specific time point based on the information from various 'R-hub' web services . The dependency graph can then be used to reconstruct the R computational environment with 'Rocker' . @@ -20,20 +46,45 @@ Resolve the dependency graph of R packages at a specific time point based on the * Computational Reproducibility * Open Science -## Science Usecase(s) +## Use Cases + - - +This package is designed to retrospectively construct a constant computational environment for running shared R scripts, in which the computational environment is **not** specified. Additional functions are provided for creating executable [research compendia](https://research-compendium.science/). - +## Input Data + -This package is designed to retrospectively construct a constant computational environment for running shared R scripts, in which the computational environment is **not** specified. Additional functions are provided for creating executable [research compendia](https://research-compendium.science/). +The main function `resolve()` accepts various input data. One example is a path to a directory of R scripts. -## Repository structure +## Output Data + -This repository follows [the standard structure of an R package](https://cran.r-project.org/doc/FAQ/R-exts.html#Package-structure). +The main function `resolve()` gives an S3 object of dependency graph. Please refer to @sec-touse. + +## Hardware Requirements + + +Rang runs on any hardware that can run R. ## Environment Setup + With R installed: @@ -43,19 +94,15 @@ install.packages("rang") Installation of [Docker](https://www.docker.com/) or [Singularity](https://sylabs.io/singularity/) is strongly recommended. -## Input Data - -The main function `resolve()` accepts various input data. One example is a path to a directory of R scripts. - -## Output Data - -The main function `resolve()` gives an S3 object of dependency graph. Please refer to @sec-touse. - -## Hardware Requirements +## Repository structure -Rang runs on any hardware that can run R. +This repository follows [the standard structure of an R package](https://cran.r-project.org/doc/FAQ/R-exts.html#Package-structure). -## How to Use {#sec-touse} +## How to Use + Suppose you would like to run this code snippet in [this 2018 paper](https://joss.theoj.org/papers/10.21105/joss.00774) of the R package `quanteda` (an R package for text analysis). @@ -103,21 +150,42 @@ The launched container is based on R 3.5.1 and `quanteda` 1.3.4 and is able to r Please refer to the [official website](https://gesistsa.github.io/rang/) for further information. ## Technical Details + See the [publication](https://doi.org/10.1371/journal.pone.0286761) for information about technical details. -## Contact Details +## References + -Maintainer: Chung-hong Chan +Chan, C. H., & Schoch, D. (2023). rang: Reconstructing reproducible R computational environments. PLoS ONE, 18(6): e0286761. . -Issue Tracker: [https://github.com/gesistsa/rang/issues](https://github.com/gesistsa/rang/issues) + + -## Publication + + -Chan, C. H., & Schoch, D. (2023). rang: Reconstructing reproducible R computational environments. PLoS ONE, 18(6): e0286761. . +## Contact Details + - - +Maintainer: Chung-hong Chan - - +Issue Tracker: [https://github.com/gesistsa/rang/issues](https://github.com/gesistsa/rang/issues)