Edit on GitHub

Pitaya

Pitaya.funders — Method
funders(; kwargs...)

Arguments:

  • funder_id::Union{Nothing, String}: ID of a funder.
  • query::Union{Nothing, String}: A query string.
  • filter::Union{Nothing, Dict{String, String}}: Filter options.
  • offset::Union{Nothing, Int}: Number of record to start at.
  • limit::Union{Nothing, Int}: Number of results to return.
  • sample::Union{Nothing, Int}: Number of random results to return.
  • sort::Union{Nothing, String}: Field to sort on.
  • order::Union{Nothing, String}: Sort order, one of ‘asc’ or ‘desc’.
  • facet::Union{Nothing, Dict{String, Int}}: Facet options.
  • select::Union{Nothing, String}: Select specific fields.
  • works::Bool: If true, works returned as well.
  • cursor::Union{Nothing, String}: Cursor character string to do deep paging.

Returns:

  • Dict
source
Pitaya.journals — Method
journals(; kwargs...)

Arguments:

  • issn::Union{Nothing, String}: A issn of a journal.
  • query::Union{Nothing, String}: A query string.
  • filter::Union{Nothing, Dict{String, String}}: Filter options.
  • offset::Union{Nothing, Int}: Number of record to start at.
  • limit::Union{Nothing, Int}: Number of results to return.
  • sample::Union{Nothing, Int}: Number of random results to return.
  • sort::Union{Nothing, String}: Field to sort on.
  • order::Union{Nothing, String}: Sort order, one of ‘asc’ or ‘desc’.
  • facet::Union{Nothing, Dict{String, Int}}: Facet options.
  • select::Union{Nothing, String}: Select specific fields.
  • works::Bool: If true, works returned as well.
  • cursor::Union{Nothing, String}: Cursor character string to do deep paging.

Returns:

  • Dict
source
Pitaya.licenses — Method
licenses(; kwargs...)

Arguments:

  • query::Union{Nothing, String}: A query string.
  • offset::Union{Nothing, Int}: Number of record to start at.
  • limit::Union{Nothing, Int}: Number of results to return.
  • sample::Union{Nothing, Int}: Number of random results to return.
  • sort::Union{Nothing, String}: Field to sort on.
  • order::Union{Nothing, String}: Sort order, one of ‘asc’ or ‘desc’.
  • facet::Union{Nothing, Dict{String, Int}}: Facet options.

Returns:

  • Dict
source
Pitaya.members — Method
members(; kwargs...)

Arguments:

  • member_id::Union{Nothing, Int}: ID of a Crossref member.
  • query::Union{Nothing, String}: A query string.
  • filter::Union{Nothing, Dict{String, String}}: Filter options.
  • offset::Union{Nothing, Int}: Number of record to start at.
  • limit::Union{Nothing, Int}: Number of results to return.
  • sample::Union{Nothing, Int}: Number of random results to return.
  • sort::Union{Nothing, String}: Field to sort on.
  • order::Union{Nothing, String}: Sort order, one of ‘asc’ or ‘desc’.
  • facet::Union{Nothing, Dict{String, Int}}: Facet options.
  • select::Union{Nothing, String}: Select specific fields.
  • works::Bool: If true, works returned as well.
  • cursor::Union{Nothing, String}: Cursor character string to do deep paging.

Returns:

  • Dict
source
Pitaya.prefixes — Method
prefixes(; kwargs...)

Arguments:

  • owner_prefix::Union{Nothing, String}: A DOI owner prefix.
  • query::Union{Nothing, String}: A query string.
  • filter::Union{Nothing, Dict{String, String}}: Filter options.
  • offset::Union{Nothing, Int}: Number of record to start at.
  • limit::Union{Nothing, Int}: Number of results to return.
  • sample::Union{Nothing, Int}: Number of random results to return.
  • sort::Union{Nothing, String}: Field to sort on.
  • order::Union{Nothing, String}: Sort order, one of ‘asc’ or ‘desc’.
  • facet::Union{Nothing, Dict{String, Int}}: Facet options.
  • select::Union{Nothing, String}: Select specific fields.
  • works::Bool: If true, works returned as well.
  • cursor::Union{Nothing, String}: Cursor character string to do deep paging.

Returns:

  • Dict
source
Pitaya.types — Method
types(; kwargs...)

Arguments:

  • type_id::Union{Nothing, String}: ID of a metadata work type.
  • query::Union{Nothing, String}: A query string.
  • filter::Union{Nothing, Dict{String, String}}: Filter options.
  • offset::Union{Nothing, Int}: Number of record to start at.
  • limit::Union{Nothing, Int}: Number of results to return.
  • sample::Union{Nothing, Int}: Number of random results to return.
  • sort::Union{Nothing, String}: Field to sort on.
  • order::Union{Nothing, String}: Sort order, one of ‘asc’ or ‘desc’.
  • facet::Union{Nothing, Dict{String, Int}}: Facet options.
  • select::Union{Nothing, String}: Select specific fields.
  • works::Bool: If true, works returned as well.
  • cursor::Union{Nothing, String}: Cursor character string to do deep paging.

Returns:

  • Dict
source
Pitaya.works — Method
works(; kwargs...)

Arguments:

  • doi::Union{Nothing, String}: DOI of the work.
  • query::Union{Nothing, String}: A query string.
  • filter::Union{Nothing, Dict{String, String}}: Filter options.
  • offset::Union{Nothing, Int}: Number of record to start at.
  • limit::Union{Nothing, Int}: Number of results to return.
  • sample::Union{Nothing, Int}: Number of random results to return.
  • sort::Union{Nothing, String}: Field to sort on.
  • order::Union{Nothing, String}: Sort order, one of ‘asc’ or ‘desc’.
  • facet::Union{Nothing, Dict{String, Int}}: Facet options.
  • select::Union{Nothing, String}: Select specific fields.
  • cursor::Union{Nothing, String}: Cursor character string to do deep paging.

Returns:

  • Dict
source