Data

Tools

Indexes

Applications

Experiments

Open Source Science

here

A simpler way to find your files

https://github.com/r-lib/here

Science Score: 36.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
    2 of 15 committers (13.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.5%) to scientific vocabulary

Keywords

project r

Keywords from Contributors

tidy-data grammar data-manipulation visualisation latex documentation-tool rmarkdown package-creation interface travis-ci
Last synced: 6 months ago · JSON representation

Repository

A simpler way to find your files

Basic Info
  • Host: GitHub
  • Owner: r-lib
  • License: other
  • Language: R
  • Default Branch: main
  • Homepage: https://here.r-lib.org/
  • Size: 2.12 MB
Statistics
  • Stars: 425
  • Watchers: 8
  • Forks: 45
  • Open Issues: 36
  • Releases: 3
Topics
project r
Created over 9 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Code of conduct

README.Rmd 

---
output:
  github_document:
    html_preview: false
---



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

pkgload::load_all()

set.seed(20230702)

clean_output <- function(x, options) {
  # Side effect
  usethis::use_build_ignore("index.md")

  x <- gsub("0x[0-9a-f]+", "0xdeadbeef", x)
  x <- gsub("dataframe_[0-9]*_[0-9]*", "      dataframe_42_42      ", x)
  x <- gsub("[0-9]*\\.___row_number ASC", "42.___row_number ASC", x)

  index <- x
  index <- gsub("─", "-", index)
  index <- strsplit(paste(index, collapse = "\n"), "\n---\n")[[1]][[2]]
  writeLines(index, "index.md")

  x <- gsub('(`vignette[(]"([^"]+)"[)]`)', "[\\1](https://rprojroot.r-lib.org/articles/\\2.html)", x)
  x <- fansi::strip_sgr(x)
  x
}

options(
  cli.num_colors = 256,
  cli.width = 71,
  width = 71,
  pillar.bold = TRUE,
  pillar.max_title_chars = 5,
  pillar.min_title_chars = 5,
  pillar.max_footer_lines = 12,
  conflicts.policy = list(warn = FALSE)
)

local({
  hook_source <- knitr::knit_hooks$get("document")
  knitr::knit_hooks$set(document = clean_output)
})

rlang::local_interactive(FALSE)
```

# here


[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![rcc](https://github.com/r-lib/here/workflows/rcc/badge.svg)](https://github.com/r-lib/here/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/here)](https://CRAN.R-project.org/package=here)
[![Codecov test coverage](https://codecov.io/gh/r-lib/here/branch/main/graph/badge.svg)](https://codecov.io/gh/r-lib/here?branch=main)


The goal of the here package is to enable easy file referencing in [project-oriented workflows](https://rstats.wtf/projects.html).
In contrast to using `setwd()`, which is fragile and dependent on the way you organize your files, here uses the top-level directory of a project to easily build paths to files.

## Installation

Install the released version of here from CRAN:
```{r, eval = FALSE}
install.packages("here")
```


## Usage

The here package creates paths relative to the top-level directory. The package displays the top-level of the current project on load or any time you call `here()`:

```{r}
here::i_am("README.Rmd")
here()
```

You can build a path relative to the top-level directory in order to read or write a file:

```{r}
here("inst", "demo-project", "data", "penguins.csv")
readr::write_csv(palmerpenguins::penguins, here("inst", "demo-project", "data", "penguins.csv"))
```

These relative paths work regardless of where the associated source file lives inside your project, like analysis projects with data and reports in different subdirectories.
See the included [demo project](https://github.com/r-lib/here/tree/main/inst/demo-project) for an example.

![](https://raw.githubusercontent.com/allisonhorst/stats-illustrations/master/rstats-artwork/here.png)
*Illustration by [Allison Horst](https://github.com/allisonhorst)*

---

## Code of Conduct

Please note that the here project is released with a [Contributor Code of Conduct](https://here.r-lib.org/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

Owner

  • Name: R infrastructure
  • Login: r-lib
  • Kind: organization

GitHub Events

Total
  • Issues event: 5
  • Watch event: 11
  • Delete event: 8
  • Issue comment event: 23
  • Push event: 95
  • Pull request review event: 2
  • Pull request review comment event: 6
  • Pull request event: 51
  • Fork event: 1
  • Create event: 26
Last Year
  • Issues event: 5
  • Watch event: 11
  • Delete event: 8
  • Issue comment event: 23
  • Push event: 95
  • Pull request review event: 2
  • Pull request review comment event: 6
  • Pull request event: 51
  • Fork event: 1
  • Create event: 26

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 428
  • Total Committers: 15
  • Avg Commits per committer: 28.533
  • Development Distribution Score (DDS): 0.121
Past Year
  • Commits: 43
  • Committers: 2
  • Avg Commits per committer: 21.5
  • Development Distribution Score (DDS): 0.023
Top Committers
Name Email Commits
Kirill Müller k****r@m****g 376
Kirill Müller k****r@i****h 27
Indrajeet Patil p****e@g****m 7
Mara Averick m****k@g****m 4
Wael Sadek w****k@g****m 3
GitHub n****y@g****m 2
Hugo Gruson B****o 1
Jack Davison 4****n 1
Maëlle Salmon m****n@y****e 1
Paul Frischknecht p****t@b****h 1
Rajanand Ilangovan r****d@o****m 1
Sharla Gelfand s****d@g****m 1
nzgwynn n****n@g****m 1
t-gummer t****r@g****m 1
Jennifer (Jenny) Bryan j****y@s****a 1
Committer Domains (Top 20 + Academic)
stat.ubc.ca: 1 bluewin.ch: 1 github.com: 1 ivt.baug.ethz.ch: 1 mailbox.org: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 77
  • Total pull requests: 86
  • Average time to close issues: 7 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 64
  • Total pull request authors: 16
  • Average comments per issue: 3.53
  • Average comments per pull request: 0.62
  • Merged pull requests: 61
  • Bot issues: 0
  • Bot pull requests: 18
Past Year
  • Issues: 5
  • Pull requests: 53
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 1 day
  • Issue authors: 4
  • Pull request authors: 4
  • Average comments per issue: 0.6
  • Average comments per pull request: 0.21
  • Merged pull requests: 36
  • Bot issues: 0
  • Bot pull requests: 18
View more stats
Top Authors
Issue Authors
  • krlmlr (6)
  • jennybc (6)
  • hadley (3)
  • ijlyttle (2)
  • DCEW (1)
  • fthielen (1)
  • StevenMMortimer (1)
  • LTzavella (1)
  • bpfree (1)
  • MichalLauer (1)
  • beevabeeva (1)
  • moodymudskipper (1)
  • JamesCuster (1)
  • mollystevens-noaa (1)
  • karldw (1)
Pull Request Authors
  • krlmlr (47)
  • github-actions[bot] (18)
  • jennybc (3)
  • batpigandme (3)
  • chapb (2)
  • Yunuuuu (2)
  • jack-davison (2)
  • sharlagelfand (1)
  • t-gummer (1)
  • Masterxilo (1)
  • beevabeeva (1)
  • rajanand (1)
  • moutikabdessabour (1)
  • ghost (1)
  • nzgwynn (1)
Top Labels
Issue Labels
documentation (3) tidy-dev-day :nerd_face: (3) help wanted :heart: (2)
Pull Request Labels
mergequeue (2)

Packages

  • Total packages: 2
  • Total downloads:
    • cran 353,393 last-month
  • Total docker downloads: 838,291
  • Total dependent packages: 129
    (may contain duplicates)
  • Total dependent repositories: 879
    (may contain duplicates)
  • Total versions: 5
  • Total maintainers: 1
cran.r-project.org: here

A Simpler Way to Find Your Files

  • Versions: 3
  • Dependent Packages: 129
  • Dependent Repositories: 879
  • Downloads: 353,393 Last month
  • Docker Downloads: 838,291
Rankings
Dependent repos count: 0.4%
Dependent packages count: 0.8%
Stargazers count: 1.0%
Downloads: 1.0%
Forks count: 1.6%
Average: 3.7%
Docker downloads count: 17.3%
Maintainers (1)
krlmlr+r@mailbox.org
Last synced: 6 months ago
proxy.golang.org: github.com/r-lib/here
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • rprojroot >= 2.0.2 imports
  • conflicted * suggests
  • covr * suggests
  • fs * suggests
  • knitr * suggests
  • palmerpenguins * suggests
  • plyr * suggests
  • readr * suggests
  • rlang * suggests
  • rmarkdown * suggests
  • testthat * suggests
  • uuid * suggests
  • withr * suggests
.github/workflows/R-CMD-check-dev.yaml actions
  • ./.github/workflows/check * composite
  • ./.github/workflows/custom/after-install * composite
  • ./.github/workflows/custom/before-install * composite
  • ./.github/workflows/dep-matrix * composite
  • ./.github/workflows/install * composite
  • ./.github/workflows/rate-limit * composite
  • ./.github/workflows/update-snapshots * composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/R-CMD-check.yaml actions
  • ./.github/workflows/check * composite
  • ./.github/workflows/commit * composite
  • ./.github/workflows/custom/after-install * composite
  • ./.github/workflows/custom/before-install * composite
  • ./.github/workflows/git-identity * composite
  • ./.github/workflows/install * composite
  • ./.github/workflows/pkgdown-build * composite
  • ./.github/workflows/pkgdown-deploy * composite
  • ./.github/workflows/rate-limit * composite
  • ./.github/workflows/roxygenize * composite
  • ./.github/workflows/style * composite
  • ./.github/workflows/update-snapshots * composite
  • actions/checkout v3 composite
.github/workflows/check/action.yml actions
  • actions/upload-artifact main composite
  • r-lib/actions/check-r-package v2 composite
.github/workflows/fledge.yaml actions
  • ./.github/workflows/git-identity * composite
  • ./.github/workflows/install * composite
  • actions/checkout v2 composite
.github/workflows/install/action.yml actions
  • ./.github/workflows/get-extra * 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/lock.yaml actions
  • dessant/lock-threads v2 composite
.github/workflows/pkgdown-deploy/action.yml actions
  • nick-fields/retry v2 composite
.github/workflows/pkgdown.yaml actions
  • ./.github/workflows/custom/after-install * composite
  • ./.github/workflows/custom/before-install * composite
  • ./.github/workflows/git-identity * composite
  • ./.github/workflows/install * composite
  • ./.github/workflows/pkgdown-build * composite
  • ./.github/workflows/pkgdown-deploy * composite
  • ./.github/workflows/rate-limit * composite
  • actions/checkout v3 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/pr-fetch master composite
  • r-lib/actions/pr-push master composite
  • r-lib/actions/setup-r master composite
.github/workflows/revdep.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v2 composite
.github/workflows/style/action.yml actions
  • actions/cache v3 composite
.github/workflows/update-snapshots/action.yml actions
  • peter-evans/create-pull-request v4 composite