amcat.hits: Conduct a query on amcat

Description Usage Arguments Value

View source: R/query.r

Description

This function is similar to using the 'show article list' function in AmCAT. It allows you to specify a number of queries and get document metadata and number of hits per document

Usage

1
2
3
4
5
6
7
8
9
amcat.hits(
  conn,
  queries,
  labels = queries,
  sets,
  minimal = T,
  warn.no.result = T,
  ...
)

Arguments

conn

the connection object from amcat.connect

queries

a vector of queries to run

labels

if given, labels corresponding to the queries. Alternatively, if a query starts with a label and a hashtag (e.g., label# "term1 term2"), this label is used.

sets

one or more article set ids to query on

...

additional arguments to pass to the AmCAT API, e.g. extra filters

Value

A data frame with hits per article


amcat/amcat-r documentation built on Dec. 26, 2021, 3:12 a.m.