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
|
<!-- README.md is generated from README.Rmd. Please edit that file -->
# zip
> Cross-Platform ‘zip’ Compression
<!-- badges: start -->
[](https://github.com/r-lib/zip/actions/workflows/R-CMD-check.yaml)
[](https://www.r-pkg.org/pkg/zip)
[](https://www.r-pkg.org/pkg/zip)
[](https://app.codecov.io/gh/r-lib/zip)
<!-- badges: end -->
## Installation
Stable version:
``` r
install.packages("zip")
```
Development version:
``` r
pak::pak("r-lib/zip")
```
## Usage
``` r
library(zip)
```
### Creating ZIP files
`zip()` creates a new ZIP archive. (It overwrites the output file if it
exists.) Simply supply all directories and files that you want to
include in the archive.
It makes sense to change to the top-level directory of the files before
archiving them, so that the files are stored using a relative path name.
``` r
zip("sources.zip", c("R", "src"))
file.info("sources.zip")
#> size isdir mode mtime ctime
#> sources.zip 603127 FALSE 644 2025-01-07 10:40:54 2025-01-07 10:40:54
#> atime uid gid uname grname
#> sources.zip 2023-11-03 17:09:37 501 20 gaborcsardi staff
```
Directories are added recursively by default.
`zip_append()` is similar to `zip()`, but it appends files to an
existing ZIP archive.
### Listing ZIP files
`zip_list()` lists files in a ZIP archive. It returns a data frame:
``` r
zip_list("sources.zip")
#> # A data frame: 49 × 7
#> filename compressed_size uncompressed_size timestamp permissions
#> <chr> <dbl> <dbl> <dttm> <octmode>
#> 1 R/ 0 0 2025-01-07 09:36:04 755
#> 2 R/assertio… 151 398 2023-04-17 10:20:40 644
#> 3 R/compat-v… 3333 13294 2025-01-07 09:36:04 644
#> 4 R/inflate.R 627 2174 2023-04-17 10:20:40 644
#> 5 R/process.R 1793 6585 2023-04-17 10:20:40 644
#> 6 R/utils.R 1184 3757 2025-01-07 09:36:50 644
#> 7 R/zip-pack… 99 122 2023-11-07 01:18:44 644
#> 8 R/zip.R 3290 10384 2025-01-07 09:39:50 644
#> 9 src/ 0 0 2025-01-07 09:01:34 755
#> 10 src/init.c 406 1043 2023-11-07 01:18:16 644
#> # ℹ 39 more rows
#> # ℹ 2 more variables: crc32 <hexmode>, offset <dbl>
```
### Uncompressing ZIP files
`unzip()` uncompresses a ZIP archive:
``` r
exdir <- tempfile()
unzip("sources.zip", exdir = exdir)
dir(exdir)
#> [1] "R" "src"
```
### Compressing and uncompressing in background processes
You can use the `zip_process()` and `unzip_process()` functions to
create background zip / unzip processes. These processes were
implemented on top of the `processx::process` class, so they are
pollable.
## License
MIT
|
