man-roxygen/high.r

In ropensci/rplos: Interface to the Search API for 'PLoS' Journals

#' @param q Search terms (character). You can search on specific fields by
#'    doing 'field:your query'. For example, a real query on a specific field would
#'    be 'author:Smith'.
#' @param fl Fields to return from search (character) [e.g., 'id,title'],
#'    any combination of search fields [type 'data(plosfields)', then
#'    'plosfields'].
#' @param fq List specific fields to filter the query on (if NA, all queried).
#'    The options for this parameter are the same as those for the fl parameter.
#'    Note that using this parameter doesn't influence the actual query, but is used
#'    to filter the resuls to a subset of those you want returned. For example,
#'    if you want full articles only, you can do 'doc_type:full'. In another example,
#'    if you want only results from the journal PLOS One, you can do
#'    'journal_key:PLoSONE'. See journalnamekey() for journal
#'    abbreviations.
#' @param hl.q Set a query request to be highlighted. It overrides q parameter for
#' highlighting. Solr query syntax is acceptable for this parameter.
#' @param hl.fl A comma-separated list of fields for which to generate highlighted snippets.
#' If left blank, the fields highlighted for the LuceneQParser are the defaultSearchField
#' (or the df param if used) and for the DisMax parser the qf fields are used. A '*' can
#' be used to match field globs, e.g. 'text_*' or even '*' to highlight on all fields where
#' highlighting is possible. When using '*', consider adding hl.requireFieldMatch=TRUE.
#' @param hl.snippets Max no. of highlighted snippets to generate per field. Note:
#' it is possible for any number of snippets from zero to this value to be generated.
#' This parameter accepts per-field overrides. Default: 1.
#' @param hl.fragsize The size, in characters, of the snippets (aka fragments) created by
#' the highlighter. In the original Highlighter, "0" indicates that the whole field value
#' should be used with no fragmenting. See
#' https://cwiki.apache.org/confluence/display/solr/HighlightingParameters for more info
#' @param hl.mergeContiguous Collapse contiguous fragments into a single fragment. "true"
#' indicates contiguous fragments will be collapsed into single fragment. This parameter
#' accepts per-field overrides. This parameter makes sense for the original Highlighter
#' only. Default: FALSE.
#' @param hl.requireFieldMatch If TRUE, then a field will only be highlighted if the
#' query matched in this particular field (normally, terms are highlighted in all
#' requested fields regardless of which field matched the query). This only takes effect
#' if "hl.usePhraseHighlighter" is TRUE. Default: FALSE.
#' @param hl.maxAnalyzedChars How many characters into a document to look for suitable
#' snippets. This parameter makes sense for the original Highlighter only. Default: 51200.
#' You can assign a large value to this parameter and use hl.fragsize=0 to return
#' highlighting in large fields that have size greater than 51200 characters.
#' @param hl.alternateField If a snippet cannot be generated (due to no terms matching),
#' you can specify a field to use as the fallback. This parameter accepts per-field overrides.
#' @param hl.maxAlternateFieldLength If hl.alternateField is specified, this parameter
#' specifies the maximum number of characters of the field to return. Any value less than or
#' equal to 0 means unlimited. Default: unlimited.
#' @param hl.preserveMulti Preserve order of values in a multiValued list. Default: FALSE.
#' @param hl.maxMultiValuedToExamine When highlighting a multiValued field, stop examining
#' the individual entries after looking at this many of them. Will potentially return 0
#' snippets if this limit is reached before any snippets are found. If maxMultiValuedToMatch
#' is also specified, whichever limit is hit first will terminate looking for more.
#' Default: Integer.MAX_VALUE
#' @param hl.maxMultiValuedToMatch When highlighting a multiValued field, stop examining
#' the individual entries after looking at this many matches are found. If
#' maxMultiValuedToExamine is also specified, whichever limit is hit first will terminate
#' looking for more. Default: Integer.MAX_VALUE
#' @param hl.formatter Specify a formatter for the highlight output. Currently the only
#' legal value is "simple", which surrounds a highlighted term with a customizable pre- and
#' post text snippet. This parameter accepts per-field overrides. This parameter makes
#' sense for the original Highlighter only.
#' @param hl.simple.pre The text which appears before and after a highlighted term when using
#' the simple formatter. This parameter accepts per-field overrides. The default values are
#' "<em>" and "</em>" This parameter makes sense for the original Highlighter only. Use
#' hl.tag.pre and hl.tag.post for FastVectorHighlighter (see example under hl.fragmentsBuilder)
#' @param hl.simple.post The text which appears before and after a highlighted term when using
#' the simple formatter. This parameter accepts per-field overrides. The default values are
#' "<em>" and "</em>" This parameter makes sense for the original Highlighter only. Use
#' hl.tag.pre and hl.tag.post for FastVectorHighlighter (see example under hl.fragmentsBuilder)
#' @param hl.fragmenter Specify a text snippet generator for highlighted text. The standard
#' fragmenter is gap (which is so called because it creates fixed-sized fragments with gaps
#' for multi-valued fields). Another option is regex, which tries to create fragments that
#' "look like" a certain regular expression. This parameter accepts per-field overrides.
#' Default: "gap"
#' @param hl.fragListBuilder Specify the name of SolrFragListBuilder.  This parameter
#' makes sense for FastVectorHighlighter only. To create a fragSize=0 with the
#' FastVectorHighlighter, use the SingleFragListBuilder. This field supports per-field
#' overrides.
#' @param hl.fragmentsBuilder Specify the name of SolrFragmentsBuilder. This parameter makes
#' sense for FastVectorHighlighter only.
#' @param hl.boundaryScanner Configures how the boundaries of fragments are determined. By
#' default, boundaries will split at the character level, creating a fragment such as "uick
#' brown fox jumps over the la". Valid entries are breakIterator or simple, with breakIterator
#' being the most commonly used. This parameter makes sense for FastVectorHighlighter only.
#' @param hl.bs.maxScan Specify the length of characters to be scanned by SimpleBoundaryScanner.
#' Default: 10.  This parameter makes sense for FastVectorHighlighter only.
#' @param hl.bs.chars Specify the boundary characters, used by SimpleBoundaryScanner.
#' This parameter makes sense for FastVectorHighlighter only.
#' @param hl.bs.type Specify one of CHARACTER, WORD, SENTENCE and LINE, used by
#' BreakIteratorBoundaryScanner. Default: WORD. This parameter makes sense for
#' FastVectorHighlighter only.
#' @param hl.bs.language Specify the language for Locale that is used by
#' BreakIteratorBoundaryScanner. This parameter makes sense for FastVectorHighlighter only.
#' Valid entries take the form of ISO 639-1 strings.
#' @param hl.bs.country Specify the country for Locale that is used by
#' BreakIteratorBoundaryScanner. This parameter makes sense for FastVectorHighlighter only.
#' Valid entries take the form of ISO 3166-1 alpha-2 strings.
#' @param hl.useFastVectorHighlighter Use FastVectorHighlighter. FastVectorHighlighter
#' requires the field is termVectors=on, termPositions=on and termOffsets=on. This
#' parameter accepts per-field overrides. Default: FALSE
#' @param hl.usePhraseHighlighter Use SpanScorer to highlight phrase terms only when
#' they appear within the query phrase in the document. Default: TRUE.
#' @param hl.highlightMultiTerm If the SpanScorer is also being used, enables highlighting
#' for range/wildcard/fuzzy/prefix queries. Default: FALSE. This parameter makes sense
#' for the original Highlighter only.
#' @param hl.regex.slop Factor by which the regex fragmenter can stray from the ideal
#' fragment size (given by hl.fragsize) to accomodate the regular expression. For
#' instance, a slop of 0.2 with fragsize of 100 should yield fragments between 80
#' and 120 characters in length. It is usually good to provide a slightly smaller
#' fragsize when using the regex fragmenter. Default: .6. This parameter makes sense
#' for the original Highlighter only.
#' @param hl.regex.pattern The regular expression for fragmenting. This could be
#' used to extract sentences (see example solrconfig.xml) This parameter makes sense
#' for the original Highlighter only.
#' @param hl.regex.maxAnalyzedChars Only analyze this many characters from a field
#' when using the regex fragmenter (after which, the fragmenter produces fixed-sized
#' fragments). Applying a complicated regex to a huge field is expensive.
#' Default: 10000. This parameter makes sense for the original Highlighter only.
#' @param start Record to start at (used in combination with limit when
#'    you need to cycle through more results than the max allowed=1000)
#' @param rows Number of results to return (integer)
#' @param sleep Number of seconds to wait between requests. No need to use this for
#'    a single call to searchplos. However, if you are using searchplos in a loop or
#'    lapply type call, do sleep parameter is used to prevent your IP address from being
#'    blocked. You can only do 10 requests per minute, so one request every 6 seconds is
#'    about right.
#' @param proxy List of arguments for a proxy connection, including one or more of:
#' url, port, username, password, and auth. See \code{\link[crul]{proxy}} for
#' help, which is used to construct the proxy connection.
#' @param errors (character) One of simple or complete. Simple gives http code and
#' error message on an error, while complete gives both http code and error message,
#' and stack trace, if available.
#' @param callopts Optional additional curl options passed to
#' \code{\link[crul]{HttpClient}}
#' @param ... Further arguments passed on to solr_highlight