https://github.com/hrbrmstr/sbom

Generate Software Bill of Materials for R Things
https://github.com/hrbrmstr/sbom

r rstats sbom sbom-generator

Last synced: 11 days ago
JSON representation

Generate Software Bill of Materials for R Things

• Host: GitHub
• URL: https://github.com/hrbrmstr/sbom
• Owner: hrbrmstr
• License: other
• Created: 2022-05-29T16:42:27.000Z (over 2 years ago)
• Default Branch: batman
• Last Pushed: 2024-02-09T11:26:36.000Z (9 months ago)
• Last Synced: 2024-10-12T21:23:51.066Z (26 days ago)
• Topics: r, rstats, sbom, sbom-generator
• Language: R
• Homepage:
• Size: 39.1 KB
• Stars: 16
• Watchers: 3
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - hrbrmstr/sbom - Generate Software Bill of Materials for R Things (R)

README

        
---

output: rmarkdown::github_document

editor_options: 

  chunk_output_type: console

---

```{r pkg-knitr-opts, include=FALSE}

hrbrpkghelpr::global_opts()

```

```{r badges, results='asis', echo=FALSE, cache=FALSE}

hrbrpkghelpr::stinking_badges()

```

```{r description, results='asis', echo=FALSE, cache=FALSE}

hrbrpkghelpr::yank_title_and_description()

```

## Help Wanted/TODOs

### Issues

- [ ] Handle Licenses (PARTIAL SUPPORT EXISTS)

- [ ] Handle Authors (PARTIAL SUPPORT EXISTS)

- [ ] Get some buy-in on purls, BOM-refs, etc 

- [ ] Handle non-CRAN packages 

- [ ] Handle Shiny apps 

- [ ] Handle R "projects" 

- [ ] Dependency trees 

- [ ] Handle system requirements & (generically) stuff in src 

## What's Inside The Tin

The following functions are implemented:

```{r ingredients, results='asis', echo=FALSE, cache=FALSE}

hrbrpkghelpr::describe_ingredients()

```

## Installation

```{r install-ex, results='asis', echo=FALSE, cache=FALSE}

hrbrpkghelpr::install_block()

```

## Usage

```{r lib-ex}

library(sbom)

# current version

packageVersion("sbom")

```

```{r ex-01}

cat(x <- cran_pkg_sbom("ndjson"))

```

```{r ex-02}

validate_sbom(text=x)

```

## sbom Metrics

```{r cloc, echo=FALSE}

cloc::cloc_pkg_md()

```

## Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. 

By participating in this project you agree to abide by its terms.