save_index: Save an index

Description Usage Arguments Value Examples

View source: R/pastec_api.R

Description

Directs Pastec to save its image index to a file on disk.

Usage

1
save_index(index_path, server)

Arguments

index_path

File the Pastec index will be saved to. (File ending should be ".dat")

server

Pastec server.

Value

Returns TRUE on success, returns false (with a warning) on failure

Examples

1
2
3
4
5
6
7
## Not run: 
ps <- pastec_server(url = "localhost", port = 4212)
save_index("index.dat", server = ps)
#> Pastec index saved to disk.
#> [1] TRUE

## End(Not run)

mdlincoln/PastecR documentation built on May 22, 2019, 4:03 p.m.