Data

Tools

Indexes

Applications

Experiments

Open Source Science

config

config package for R

https://github.com/rstudio/config

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (19.2%) to scientific vocabulary

Keywords from Contributors

rmarkdown pandoc posit-connect sqlite3 documentation-tool devtools parsing fwf csv odbc
Last synced: 10 months ago · JSON representation

Repository

config package for R

Basic Info
Statistics
  • Stars: 262
  • Watchers: 10
  • Forks: 32
  • Open Issues: 19
  • Releases: 0
Created about 10 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog

README.Rmd 

---
output: github_document
format: gfm
default-image-extension: ""
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%",
  eval = TRUE
)
```




```{r child="man/fragments/knitr_with_config_hooks.Rmd", include = FALSE}
```

# config 


[![CRAN status](https://www.r-pkg.org/badges/version/config)](https://CRAN.R-project.org/package=config)
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/miniCRAN)](https://www.r-pkg.org/pkg/miniCRAN)
[![R-CMD-check](https://github.com/rstudio/config/workflows/R-CMD-check/badge.svg)](https://github.com/rstudio/config/actions)
[![Codecov test coverage](https://codecov.io/gh/rstudio/config/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rstudio/config?branch=main)



The `config` package makes it easy to manage environment specific configuration values. For example, you might want to use distinct values for development, testing, and production environments.

## Installation

You can install the `config` package from CRAN by using:

``` r
install.packages("config")
```

## Usage

To use `config`, create a file `config.yml` with default as well as other arbitrary configurations. For example:


```{yaml output.var="config_yaml"}
default:
  trials: 5
  dataset: "data-sampled.csv"
  
production:
  trials: 30
  dataset: "data.csv"
```

To read configuration values you call the `config::get` function, which returns a list containing all of the values for the currently active configuration:

```{r, with_config=TRUE, config_yml="config_yaml"}
config <- config::get()
config$trials
config$dataset
```

You can also read a single value from the configuration as follows:

```{r, with_config=TRUE, config_yml="config_yaml"}
config::get("trials")
config::get("dataset")
```

The `config::get()` function takes an optional `config` argument which determines which configuration to read values from (the "default" configuration is used if none is specified). 

## Vignettes

See the package vignettes at  for more examples and instructions for advanced usage, including:

- Inheritance and R expressions
- Using `config` on Posit Connect


```{r child="man/fragments/no_attach.Rmd"}
```

Owner

  • Name: RStudio
  • Login: rstudio
  • Kind: organization
  • Email: info@rstudio.org
  • Location: Boston, MA

GitHub Events

Total
  • Issues event: 5
  • Watch event: 10
  • Issue comment event: 6
  • Push event: 5
  • Pull request event: 2
  • Fork event: 5
Last Year
  • Issues event: 5
  • Watch event: 10
  • Issue comment event: 6
  • Push event: 5
  • Pull request event: 2
  • Fork event: 5

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 126
  • Total Committers: 9
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.46
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Andrie a****s@g****m 68
JJ Allaire jj@r****g 44
kevinykuo k****o@g****m 5
Derek McCrae Norton d****1@g****m 4
shrektan s****n@1****m 1
edavidaja d****d@p****o 1
Will Beasley w****y@h****m 1
Jim Hester j****r@g****m 1
Frank Binder f****r@n****m 1
Committer Domains (Top 20 + Academic)
nordex-online.com: 1 posit.co: 1 126.com: 1 rstudio.org: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 37
  • Total pull requests: 21
  • Average time to close issues: 10 months
  • Average time to close pull requests: 5 months
  • Total issue authors: 36
  • Total pull request authors: 17
  • Average comments per issue: 3.3
  • Average comments per pull request: 1.29
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 3
  • Average time to close issues: about 5 hours
  • Average time to close pull requests: N/A
  • Issue authors: 4
  • Pull request authors: 3
  • Average comments per issue: 1.25
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • r2evans (2)
  • DavZim (1)
  • gadenbuie (1)
  • bradleyfay (1)
  • mmoisse (1)
  • aborderon (1)
  • jeffery-leirness-noaa (1)
  • asitemade4u (1)
  • aramirezreyes (1)
  • colearendt (1)
  • kieran-mace (1)
  • gaborcsardi (1)
  • nico-schmid (1)
  • spkaluzny (1)
  • ShixiangWang (1)
Pull Request Authors
  • rappster (3)
  • edavidaja (2)
  • nachti (2)
  • kevinykuo (2)
  • kurkiewiczd (2)
  • andrie (2)
  • dermcnor (1)
  • chacalle (1)
  • fnbn (1)
  • rsparkrepo (1)
  • wibeasley (1)
  • elipousson (1)
  • IndrajeetPatil (1)
  • jimhester (1)
  • Prev-I (1)
Top Labels
Issue Labels
feature (3) reprex (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • cran 36,048 last-month
  • Total docker downloads: 74,628,086
  • Total dependent packages: 69
    (may contain duplicates)
  • Total dependent repositories: 502
    (may contain duplicates)
  • Total versions: 8
  • Total maintainers: 1
cran.r-project.org: config

Manage Environment Specific Configuration Values

  • Versions: 5
  • Dependent Packages: 64
  • Dependent Repositories: 492
  • Downloads: 36,048 Last month
  • Docker Downloads: 74,628,086
Rankings
Dependent repos count: 0.7%
Downloads: 1.2%
Dependent packages count: 1.5%
Stargazers count: 1.7%
Forks count: 2.6%
Average: 4.6%
Docker downloads count: 19.8%
Maintainers (1)
apdevries@gmail.com
Last synced: 10 months ago
conda-forge.org: r-config
  • Versions: 3
  • Dependent Packages: 5
  • Dependent Repositories: 10
Rankings
Dependent packages count: 10.4%
Dependent repos count: 11.0%
Average: 19.6%
Stargazers count: 24.9%
Forks count: 31.9%
Last synced: 10 months ago

Dependencies

DESCRIPTION cran
  • yaml >= 2.1.19 imports
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • spelling * suggests
  • testthat * suggests
  • withr * suggests
.github/workflows/check-full.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/pr-fetch v1 composite
  • r-lib/actions/pr-push v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite