Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Merck/pkglite
Compact Package Representations
https://github.com/Merck/pkglite
clinical-trials ectd package packaging-tool pharmaverse r
Last synced: 8 days ago
JSON representation
Compact Package Representations
- Host: GitHub
- URL: https://github.com/Merck/pkglite
- Owner: Merck
- License: gpl-3.0
- Created: 2021-02-24T17:10:15.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-09T21:36:57.000Z (about 1 month ago)
- Last Synced: 2024-11-30T23:13:21.456Z (11 days ago)
- Topics: clinical-trials, ectd, package, packaging-tool, pharmaverse, r
- Language: R
- Homepage: https://merck.github.io/pkglite/
- Size: 2.02 MB
- Stars: 30
- Watchers: 9
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
- top-pharma50 - **Merck/pkglite** - trials`, `ectd`, `package`, `packaging-tool`, `pharmaverse`, `r`<br><img src='https://github.com/HubTou/topgh/blob/main/icons/gstars.png'> 29 <img src='https://github.com/HubTou/topgh/blob/main/icons/forks.png'> 4 <img src='https://github.com/HubTou/topgh/blob/main/icons/code.png'> R <img src='https://github.com/HubTou/topgh/blob/main/icons/license.png'> GNU General Public License v3.0 <img src='https://github.com/HubTou/topgh/blob/main/icons/last.png'> 2024-04-26 01:43:37 | (Ranked by starred repositories)
- top-pharma50 - **Merck/pkglite** - trials`, `ectd`, `package`, `packaging-tool`, `pharmaverse`, `r`<br><img src='https://github.com/HubTou/topgh/blob/main/icons/gstars.png'> 29 <img src='https://github.com/HubTou/topgh/blob/main/icons/forks.png'> 4 <img src='https://github.com/HubTou/topgh/blob/main/icons/code.png'> R <img src='https://github.com/HubTou/topgh/blob/main/icons/license.png'> GNU General Public License v3.0 <img src='https://github.com/HubTou/topgh/blob/main/icons/last.png'> 2024-04-26 01:43:37 | (Ranked by starred repositories)
- jimsghstars - Merck/pkglite - Compact Package Representations (R)
README
# pkglite 
[](https://github.com/Merck/pkglite/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/Merck/pkglite?branch=master)
[](https://CRAN.R-project.org/package=pkglite)
[](https://CRAN.R-project.org/package=pkglite)
A tool, grammar, and standard to represent and exchange
R package source code as text files. Converts one or more source
packages to a text file and restores the package structures from the file.
- To get started, see `vignette("pkglite")`.
- To generate file specifications, see `vignette("filespec")`.
- To curate file collections, see `vignette("filecollection")`.
- The text file format is described in `vignette("format")`.
## Installation
You can install the package via CRAN:
```r
install.packages("pkglite")
```
Or, install from GitHub:
```r
remotes::install_github("Merck/pkglite")
```
## Workflow
```r
library("pkglite")
```
Pack one R package:
```r
"/path/to/package/" %>%
collate(file_default()) %>%
pack()
```
Pack multiple R packages:
```r
pack(
"/path/to/pkg1/" %>% collate(file_default()),
"/path/to/pkg2/" %>% collate(file_default()),
output = "/path/to/pkglite.txt"
)
```
Unpack one or more packages:
```r
"/path/to/pkglite.txt" %>%
unpack(output = "/path/to/output/")
```
## Citation
If you use this software, please cite it as below.
> Zhao, Y., Xiao, N., Anderson, K., & Zhang, Y. (2023).
> Electronic common technical document submission with analysis using R.
> _Clinical Trials_, **20**(1), 89--92.
> https://doi.org/10.1177/17407745221123244
A BibTeX entry for LaTeX users is
```bibtex
@article{zhao2023electronic,
title = {Electronic common technical document submission with analysis using {R}},
author = {Zhao, Yujie and Xiao, Nan and Anderson, Keaven and Zhang, Yilong},
journal = {Clinical Trials},
volume = {20},
number = {1},
pages = {89--92},
year = {2023},
doi = {10.1177/17407745221123244}
}
```