-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
136 lines (89 loc) · 4.38 KB
/
Copy pathREADME.Rmd
File metadata and controls
136 lines (89 loc) · 4.38 KB
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%"
)
```
rdeps <img src="man/figures/logo.png" align="right" style="float:right; height:120px;"/>
=========================================================
<!-- badges: start -->
[](https://CRAN.R-project.org/package=rdeps)
[](https://github.com/frbcesab/rdeps/actions/workflows/R-CMD-check.yaml)
[](https://github.com/frbcesab/rdeps/actions/workflows/pkgdown.yaml)
[](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->
<p align="left">
• <a href="#overview">Overview</a><br>
• <a href="#features">Features</a><br>
• <a href="#installation">Installation</a><br>
• <a href="#get-started">Get started</a><br>
• <a href="#citation">Citation</a><br>
• <a href="#contributing">Contributing</a>
</p>
## Overview
The goal of the R package `rdeps` is to provide a tool to identify all external
packages used in a project (package, compendium, website, etc.) and to list
them in the [`DESCRIPTION`](https://r-pkgs.org/description.html) file.
## Features
`rdeps` screens all `.R`, `.Rmd`, and `.qmd` files to extract the name of
packages used in a project. This package detects packages called with
`library(foo)`, `require(foo)`, `foo::bar()`, and `use("foo", "bar")` and adds
these dependencies to the `DESCRIPTION` file in the sections
_Depends_, _Imports_, and _Suggests_.
Different types of dependencies are handled:
- if the package is called with `library(foo)` or `require(foo)`,
it will be added to the section **Depends** of the `DESCRIPTION` file
(except for vignettes and tests);
- if the package is called with `foo::bar()` or `use("foo", "bar")`,
it will be added to the section **Imports** of the `DESCRIPTION` file
(except for vignettes and tests);
- if the package is only used in vignettes or tests,
it will be added to the section **Suggests** of the `DESCRIPTION` file.
Since the version **0.4**, `rdeps` introduces the `.rdepsignore` file. This file
can be used to ignore files or folders when screening files to detect
dependencies. This file can be handled with the function
[`add_to_rdepsignore()`](https://frbcesab.github.io/rdeps/reference/add_to_rdepsignore.html).
## Installation
You can install the stable version from [CRAN](https://cran.r-project.org/) with:
```{r eval=FALSE}
## Install stable version of < rdeps > from CRAN ----
install.packages("rdeps")
```
Or you can install the development version from [GitHub](https://github.com/) with:
```{r eval=FALSE}
## Install < remotes > package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
## Install < rdeps > from GitHub ----
remotes::install_github("frbcesab/rdeps")
```
Then you can attach the package `rdeps`:
```{r eval=FALSE}
library("rdeps")
```
## Get started
`rdeps` contains two main function:
- [`add_deps()`](https://frbcesab.github.io/rdeps/reference/add_deps.html).
- [`add_to_rdepsignore()`](https://frbcesab.github.io/rdeps/reference/add_to_rdepsignore.html)
**Note:** the project must contain a
[`DESCRIPTION`](https://r-pkgs.org/description.html) file. A `DESCRIPTION` file
can be created and added to an existing project with the function
[`usethis::use_description()`](https://usethis.r-lib.org/reference/use_description.html).
## Citation
Please cite `rdeps` as:
> Casajus Nicolas (`r format(Sys.Date(), "%Y")`) rdeps: An R
package to identify external packages used in a project. R package version 0.4,
<https://github.com/frbcesab/rdeps/>.
## Contributing
All types of contributions are encouraged and valued. For more information,
check out our [Contributor Guidelines](https://github.com/frbcesab/rdeps/blob/main/CONTRIBUTING.md).
Please note that the `rdeps` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.