Skip to contents

Export corpus as self-contained ZIP bundle

Source: R/export-zip.R
sm_export_zip.Rd

Build a ZIP archive containing the corpus RDS, certificate, figures, tables, and an auto-generated README. This is the "send everything to a collaborator" workflow.

Usage

sm_export_zip(
  corpus,
  path,
  include = c("rds", "certificate", "tables"),
  figure_formats = c("png"),
  figure_dpi = c(300),
  report_template = "standard"
)

Arguments

corpus

An sm_corpus object.

path

Output ZIP file path.

include

Components to include in the bundle.

figure_formats

Figure output formats.

figure_dpi

Figure resolutions.

report_template

Quarto report template.

Value

path invisibly.

See also

Other export: sm_export_csv(), sm_export_cytoscape(), sm_export_figure(), sm_export_gephi(), sm_export_quarto_report(), sm_export_rds(), sm_export_table(), sm_export_vosviewer()

Examples

# \donttest{
corpus <- sm_example_corpus(n_works = 10)
path <- tempfile(fileext = ".zip")
sm_export_zip(corpus, path, include = c("rds", "certificate"))
#> ✔ Corpus saved to /tmp/RtmpIQMgiF/file2370113418ee/corpus.rds
#> ✔ Certificate written to /tmp/RtmpIQMgiF/file2370113418ee/certificate.yaml.
#> ✔ Certificate created. Corpus hash: 58b250d94efb
#> ✔ Bundle saved to /tmp/RtmpIQMgiF/file237017dbc423.zip
# }