create_snapshot: Snapshot of your epitweetr installation
In epitweetr: Early Detection of Public Health Threats from 'Twitter' Data

create_snapshot

R Documentation

Snapshot of your epitweetr installation

Description

Creates a snapshot file of your epitweetr installation folder. This can include all or a subset of the data files.

Usage

create_snapshot(
  destination_dir,
  types = c("settings", "dependencies", "machine-learning", "aggregations", "tweets",
    "logs"),
  tweets_period = get_aggregated_period(),
  aggregated_period = get_aggregated_period(),
  compress = TRUE,
  progress = function(v, m) message(paste(round(v * 100, 2), m))
)

Arguments

`destination_dir,`	character(1) vector with the path of the destination folder to produce the snapshot
`types,`	character vector indicating the types of data to include on a snapshot. Some of: "settings", "dependencies", "machine-learning", "aggregations", "tweets", "logs"
`tweets_period,`	date(2) start and end dates to filter tweets to include on snapshot (if selected)
`aggregated_period,`	date(2) start and end dates to filter time series to include on snapshot (if selected)
`compress,`	logical(1) whether to compress or not the output file
`progress,`	function to report progress during execution.

Details

This function can be used to create a a portable file to move your epitweetr installation in a single file, to backup your data, to archive your old data or to send information to technical team in order to reproduce an observed issue. Different kinds of data can be included on the snapshot depending on the type of parameter. Possible values are: - 'settings': Including all setting files of your installation (excluding passwords) - 'dependencies': All jars and winutils.exe on windows installations - 'machine-learning': All trained models and vectors and training data (this can include tweet text which is personal data) - 'aggregations': Epitweetr aggregated time series - 'tweets': Tweets collected by epitweetr - 'logs': Log files produced automatically on windows task scheduler tasks.

Value

Nothing

Examples

if(FALSE){
   #importing epitweer
   library(epitweetr)
   message('Please choose the epitweetr data directory')
   setup_config(file.choose())
   #creating a compressed snapshot for settings and logs
   create_snapshot(getwd(), c("settings","dependencies"), compress = TRUE)
}

epitweetr documentation built on Nov. 16, 2023, 5:07 p.m.