https://github.com/ropensci/codemetar

an R package for generating and working with codemeta
https://github.com/ropensci/codemetar

codemeta json-ld metadata peer-reviewed r r-package rstats

Last synced: 3 months ago
JSON representation

an R package for generating and working with codemeta

• Host: GitHub
• URL: https://github.com/ropensci/codemetar
• Owner: ropensci
• Created: 2017-03-29T20:23:39.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-02-20T08:24:35.000Z (9 months ago)
• Last Synced: 2024-06-19T06:00:39.520Z (5 months ago)
• Topics: codemeta, json-ld, metadata, peer-reviewed, r, r-package, rstats
• Language: R
• Homepage: https://docs.ropensci.org/codemetar
• Size: 1.61 MB
• Stars: 66
• Watchers: 10
• Forks: 21
• Open Issues: 24
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: CONTRIBUTING.md
  • Codemeta: codemeta.json

Awesome Lists containing this project

• jimsghstars - ropensci/codemetar - an R package for generating and working with codemeta (R)

README

        
---

output: github_document

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  message = FALSE,

  comment = "",

  fig.path = "tools/README-"

)

```

# codemetar

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/)

[![R build status](https://github.com/ropensci/codemetar/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/codemetar/actions)

[![Coverage Status](https://img.shields.io/codecov/c/github/ropensci/codemetar/main.svg)](https://codecov.io/github/ropensci/codemetar?branch=main)

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/codemetar)](https://cran.r-project.org/package=codemetar)

[![](https://badges.ropensci.org/130_status.svg)](https://github.com/ropensci/software-review/issues/130)

[![DOI](https://zenodo.org/badge/86626030.svg)](https://zenodo.org/badge/latestdoi/86626030)

[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/codemetar)](https://CRAN.R-project.org/package=codemetar)

The [codemeta](https://cran.r-project.org/package=codemeta) package provides a more minimalist approach to generating codemeta based only on DESCRIPTION and CITATION files,

while `codemetar` provides additional abilities to detect metadata from README and GitHub sources, and provide

more user feedback, suggestions, and messaging.

```{r child='man/rmdhunks/goals.Rmd'} 

```

## Why create a codemeta.json for your package?

```{r child='man/rmdhunks/whybother.Rmd'} 

```

## Create a codemeta.json in one function call

```{r child='man/rmdhunks/example.Rmd'} 

```

## Keep codemeta.json up-to-date

```{r child='man/rmdhunks/uptodate.Rmd'} 

```

## How to improve your package's codemeta.json?

```{r child='man/rmdhunks/improvecodemetadata.Rmd'} 

```

## Installation and usage requirements

```{r child='man/rmdhunks/install-instructions.Rmd'} 

```

```{r child='man/rmdhunks/internet.Rmd'} 

```

## Going further

Check out all the [codemetar man](https://docs.ropensci.org/codemetar/articles/index.html) for tutorials on other cool stuff you can do with codemeta and json-ld.  

```{r child='man/rmdhunks/minimeta.Rmd'} 

```

```{r addscript, results="asis", echo=FALSE}

glue::glue('

      {glue::glue_collapse(readLines(file.path("inst", "schemaorg.json")), sep = "\n")}

    ')

```

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