polmineR: as.markdown – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

as.markdown

Get markdown-formatted full text of a partition.

Description

The method is the worker behind the read-method, which will be called usually to reconstruct the full text of a partition and read it. The as.markdown-method can be customized for different classes inheriting from the partition-class.

Usage

as.markdown(.Object, ...)

## S4 method for signature 'partition'
as.markdown(
  .Object,
  meta = getOption("polmineR.meta"),
  template = get_template(.Object),
  cpos = TRUE,
  cutoff = NULL,
  verbose = FALSE,
  ...
)

## S4 method for signature 'subcorpus'
as.markdown(
  .Object,
  meta = getOption("polmineR.meta"),
  template = get_template(.Object),
  cpos = TRUE,
  cutoff = NULL,
  verbose = FALSE,
  ...
)

## S4 method for signature 'plpr_partition'
as.markdown(
  .Object,
  meta = NULL,
  template = get_template(.Object),
  cpos = FALSE,
  interjections = TRUE,
  cutoff = NULL,
  ...
)

## S4 method for signature 'plpr_subcorpus'
as.markdown(
  .Object,
  meta = NULL,
  template = get_template(.Object),
  cpos = FALSE,
  interjections = TRUE,
  cutoff = NULL,
  ...
)

Arguments

`.Object`	The object to be converted, a `partition`, or a class inheriting from `partition`, such as `plpr_partition`.
`...`	further arguments
`meta`	The metainformation (s-attributes) to be displayed.
`template`	A template for formating output.
`cpos`	A `logical` value, whether to add cpos as ids in span elements.
`cutoff`	The maximum number of tokens to reconstruct, to avoid that full text is excessively long.
`verbose`	A `logical` value, whether to output messages.
`interjections`	A `logical` value, whether to format interjections.

Examples

use("polmineR")
P <- partition("REUTERS", places = "argentina")
as.markdown(P)
as.markdown(P, meta = c("id", "places"))
if (interactive()) read(P, meta = c("id", "places"))

polmineR

Verbs and Nouns for Corpus Analysis

v0.8.5

GPL-3

Authors

Andreas Blaette [aut, cre] (<https://orcid.org/0000-0001-8970-8010>), Christoph Leonhardt [ctb]

Initial release

2020-09-22