-
Notifications
You must be signed in to change notification settings - Fork 21
/
README.Rmd
83 lines (52 loc) · 2.55 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
---
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
[](https://www.repostatus.org/)
[](https://github.com/ropensci/codemetar/actions)
[](https://codecov.io/github/ropensci/codemetar?branch=main)
[](https://cran.r-project.org/package=codemetar)
[](https://github.com/ropensci/software-review/issues/130)
[](https://zenodo.org/badge/latestdoi/86626030)
[](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>')
```
[](https://ropensci.org)