Top Level Namespace

Defined Under Namespace

Modules: Arx, JSON

Instance Method Summary collapse

Instance Method Details

#Arx(*ids, query: nil, sort_by: :relevance, sort_order: :descending, start: 0, max_results: 10, &block) ⇒ Array<Paper>, Paper

Note:

This is an alias of the Arx.search method.

Note:

The sort_by and sort_order arguments are ignored if passing in your own query.

Performs a search query for papers on the arXiv search API.

Parameters:

  • ids (Array<String>) —

    The IDs of the arXiv papers to restrict the query to.

  • query (Query, NilClass) (defaults to: nil) —

    Predefined search query object.

  • sort_by (Symbol) (defaults to: :relevance) —

    The sorting criteria for the returned results (see Arx::Query::SORT_BY).

  • sort_order (Symbol) (defaults to: :descending) —

    The sorting order for the returned results (see Arx::Query::SORT_ORDER).

  • start (Integer) (defaults to: 0) —

    The index of the first returned result.

  • max_results (Integer) (defaults to: 10) —

    The number of results returned by the query

Returns:

  • (Array<Paper>, Paper) —

    The Arx::Paper(s) found by the search query.

See Also:



110
111
112
 
# File 'lib/arx.rb', line 110

def Arx(*ids, query: nil, sort_by: :relevance, sort_order: :descending, start: 0, max_results: 10, &block)
  Arx.search *ids, query: query, sort_by: sort_by, sort_order: sort_order, start: start, max_results: max_results, &block
end