gitignore

A R interface to fetch gitignore templates form gitignore.io

https://github.com/ropensci/gitignore

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
Links to: zenodo.org
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (20.6%) to scientific vocabulary

Keywords from Contributors

geocode genome mocking http-mock ropensci overpass-api air-pollution rmarkdown iucn conservation

Last synced: 9 months ago · JSON representation

Repository

A R interface to fetch gitignore templates form gitignore.io

Basic Info

Host: GitHub
Owner: ropensci
License: gpl-3.0
Language: R
Default Branch: main
Homepage: https://docs.ropensci.org/gitignore
Size: 1.28 MB

Statistics

Stars: 36
Watchers: 2
Forks: 5
Open Issues: 1
Releases: 8

Created about 7 years ago · Last pushed over 1 year ago

Metadata Files

Readme Changelog Contributing License Code of conduct Codemeta

README.Rmd

---
output: github_document
---



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



[![CRAN status](https://www.r-pkg.org/badges/version/gitignore)](https://cran.r-project.org/package=gitignore)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Codecov test coverage](https://codecov.io/gh/ropensci/gitignore/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ropensci/gitignore?branch=main)
[![DOI](https://zenodo.org/badge/184759416.svg)](https://zenodo.org/badge/latestdoi/184759416)
[![rOpenSci peer-review](https://badges.ropensci.org/303_status.svg)](https://github.com/ropensci/software-review/issues/303)
[![R-CMD-check](https://github.com/PMassicotte/gitignore/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/gitignore/actions/workflows/R-CMD-check.yaml)


Based on the definition proposed by [freecodecamp](https://www.freecodecamp.org/news/gitignore-what-is-it-and-how-to-add-to-repo/):

> The .gitignore file is a text file that tells Git which files or folders to ignore in a project. A local .gitignore file is usually placed in the root directory of a project. You can also create a global .gitignore file and any entries in that file will be ignored in all of your Git repositories.

For any project, it is therefore important to have a `.gitignore` file that is complete and accurate. The package `gitignore` provides a simple R interface to the [gitignore.io](https://www.toptal.com/developers/gitignore) API. It can be used to fetch gitignore templates that can be included into the `.gitignore` file of you git repository. The `gitignore` R package can be used with R package, R Studio project or with any `.gitignore` file. Note that by default, the `usethis` package populates the `.gitignore` for the R language when you create a R project. However, it is common to use many different programming languages in a project such as `LaTeX`, `python`, `matlab`, `julia` and so one. This is where the `gitignore` package shines as it can be used to programmatically modify the `.gitignore` file of your project.   

## Installation

The CRAN version of `gitignore` can be installed using:

```{r, eval=FALSE}
install.packages("gitignore")
```

The dev version of `gitignore` can be installed from GitHub:

```{r, eval=FALSE}
install.packages("devtools")
devtools::install_github("ropensci/gitignore")
```

## Examples

There are currently two useful functions in the package:

- `gi_available_templates()` to fetch all supported gitignore templates.
- `gi_fetch_templates()` to fetch one or many gitignore templates.

Show the first 25 templates returned by `gi_available_templates()`.

```{r}
library(gitignore)

head(gi_available_templates(), 25)
```

Templates can be fetched using the `gi_fetch_templates()` function.

```{r, results='markup', comment=""}
gi_fetch_templates("R")
```

Multiple templates can be fetched by specifying multiple values:

```{r, results='markup', comment=""}
gi_fetch_templates(c("java", "c++"))
```

By default, templates are copied into the clipboard. It is also possible to modify a `.gitignore` file using the `gi_write_gitignore()` function.

```{r, eval=FALSE}
f <- file.path(tempdir(), ".gitignore")
new_lines <- gi_fetch_templates("r")
gi_write_gitignore(fetched_template = new_lines, gitignore_file = f)
```

If `gitignore_file` is not specified, `gitignore` will try to find the `.gitignore` file of your current project or package.

More examples are provided in the vignette.

```{r, eval=FALSE}
browseVignettes("gitignore")
```

You can also visit the [gitignore website](https://docs.ropensci.org/gitignore/).

## Code of conduct

Please note that the 'gitignore' project is released with a [Contributor Code of Conduct](https://docs.ropensci.org/gitignore/CODE_OF_CONDUCT.html). By [contributing to this project](https://docs.ropensci.org/gitignore/CONTRIBUTING.html), you agree to abide by its terms.

[![ropensci_footer](https://ropensci.org/public_images/ropensci_footer.png)](https://ropensci.org)

Owner

Name: rOpenSci
Login: ropensci
Kind: organization
Email: info@ropensci.org
Location: Berkeley, CA

Website: https://ropensci.org/
Twitter: rOpenSci
Repositories: 307
Profile: https://github.com/ropensci

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "gitignore",
  "description": "Simple interface to query gitignore.io to fetch gitignore templates that can be included in the .gitignore file. More than 450 templates are currently available.",
  "name": "gitignore: Create Useful .gitignore Files for your Project",
  "relatedLink": [
    "https://docs.ropensci.org/gitignore/",
    "https://CRAN.R-project.org/package=gitignore"
  ],
  "codeRepository": "https://github.com/ropensci/gitignore",
  "issueTracker": "https://github.com/ropensci/gitignore/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.1.8.9000",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.1 (2024-06-14)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Philippe",
      "familyName": "Massicotte",
      "email": "pmassicotte@hotmail.com",
      "@id": "https://orcid.org/0000-0002-5919-4116"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Philippe",
      "familyName": "Massicotte",
      "email": "pmassicotte@hotmail.com",
      "@id": "https://orcid.org/0000-0002-5919-4116"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "covr",
      "name": "covr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=covr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "spelling",
      "name": "spelling",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=spelling"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "cli",
      "name": "cli",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=cli"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "clipr",
      "name": "clipr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=clipr"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "curl",
      "name": "curl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=curl"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "glue",
      "name": "glue",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=glue"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "here",
      "name": "here",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=here"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "jsonlite",
      "name": "jsonlite",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=jsonlite"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "purrr",
      "name": "purrr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=purrr"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "xfun",
      "name": "xfun",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=xfun"
    },
    "SystemRequirements": null
  },
  "fileSize": "70.848KB",
  "releaseNotes": "https://github.com/ropensci/gitignore/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/gitignore/blob/main/README.md",
  "contIntegration": [
    "https://app.codecov.io/gh/ropensci/gitignore?branch=main",
    "https://github.com/ropensci/gitignore/actions/workflows/R-CMD-check.yaml"
  ],
  "review": {
    "@type": "Review",
    "url": "https://github.com/ropensci/software-review/issues/303",
    "provider": "https://ropensci.org"
  }
}

GitHub Events

Total

Create event: 2
Release event: 1
Issues event: 1
Watch event: 2
Delete event: 1
Push event: 6
Pull request event: 2

Last Year

Create event: 2
Release event: 1
Issues event: 1
Watch event: 2
Delete event: 1
Push event: 6
Pull request event: 2

Committers

Last synced: over 2 years ago

All Time

Total Commits: 128
Total Committers: 6
Avg Commits per committer: 21.333
Development Distribution Score (DDS): 0.133

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Philippe Massicotte	p**e@h**m	111
mauro	m**o@i**m	12
Daniel Possenriede	p**e@g**m	2
rOpenSci Bot	m**t@g**m	1
Jeroen Ooms	j**s@g**m	1
Maëlle Salmon	m**n@y**e	1

Committer Domains (Top 20 + Academic)

ixpantia.com: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 14
Total pull requests: 13
Average time to close issues: 21 days
Average time to close pull requests: about 24 hours
Total issue authors: 3
Total pull request authors: 6
Average comments per issue: 2.07
Average comments per pull request: 1.38
Merged pull requests: 13
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 2
Pull requests: 2
Average time to close issues: 3 days
Average time to close pull requests: about 8 hours
Issue authors: 2
Pull request authors: 2
Average comments per issue: 1.5
Average comments per pull request: 0.5
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

PMassicotte (12)
pat-s (1)
jrdnbradford (1)

Pull Request Authors

PMassicotte (6)
maurolepore (3)
jrdnbradford (2)
dpprdan (2)
olivroy (2)
maelle (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 612 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 7
Total maintainers: 1

cran.r-project.org: gitignore

Create Useful .gitignore Files for your Project

Homepage: https://docs.ropensci.org/gitignore/
Documentation: http://cran.r-project.org/web/packages/gitignore/gitignore.pdf
License: GPL-3
Latest release: 0.1.8
published over 1 year ago

Versions: 7
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 612 Last month

Rankings

Stargazers count: 9.0%

Forks count: 12.2%

Dependent repos count: 23.8%

Average: 24.9%

Dependent packages count: 28.7%

Downloads: 50.9%

Maintainers (1)

pmassicotte@hotmail.com

Last synced: 10 months ago

Dependencies

DESCRIPTION cran

clipr * imports
clisymbols * imports
crayon * imports
curl * imports
glue * imports
here * imports
jsonlite * imports
purrr * imports
xfun * imports
covr * suggests
knitr * suggests
rmarkdown * suggests
spelling * suggests
testthat >= 2.1.0 suggests

.github/workflows/R-CMD-check.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

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

gitignore

Science Score: 36.0%

Keywords from Contributors

Repository

Basic Info

Statistics

Metadata Files

README.Rmd

Owner

CodeMeta (codemeta.json)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: gitignore

Rankings

Maintainers (1)

Dependencies