lnt_sample: Provides a small sample TXT/DOCX file

In JBGruber/LexisNexisTools: Working with Files from 'LexisNexis'

Provides a small sample TXT/DOCX file

Description

Copies a small TXT sample file (as used by the old Nexis) or a DOCX (as used by Nexis Uni or Lexis Advance) to the current working directory and returns the location of this newly created file. The content of the file is made up or copied from Wikipedia since real articles from LexisNexis fall under copyright laws and can not be shared.

Usage

lnt_sample(
  format = "txt",
  overwrite = FALSE,
  verbose = TRUE,
  path = NULL,
  copy = TRUE
)

Arguments

format	Either "txt" to get the sample.TXT file or "docx" to get the format used by Nexis Uni.
overwrite	Should the sample file be overwritten if found in the current working directory?
verbose	Display warning message if file exists in current wd.
path	The destination path for the sample file (current working directory if NULL)
copy	Logical. Should the file be copied to path/working directory? If FALSE, the function only returns the location of the sample file.

Details

A small sample database to test the functions of LexisNexisTools

Author(s)

Johannes Gruber

Examples

## Not run: 
  lnt_sample()

## End(Not run)

JBGruber/LexisNexisTools documentation built on April 18, 2024, 6:15 a.m.