README.Rmd

---
output: github_document
---


<!-- README.md is generated from README.Rmd. Please edit that file -->

```{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('<script type="application/ld+json">
      {glue::glue_collapse(readLines(file.path("inst", "schemaorg.json")), sep = "\n")}
    </script>')
```


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