PageRenderTime 8ms CodeModel.GetById 2ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/man/redisSort.Rd

http://github.com/bwlewis/rredis
Unknown | 58 lines | 58 code | 0 blank | 0 comment | 0 complexity | 0226dcd82f6cd2fadf661833382b3012 MD5 | raw file
 1\name{redisSort}
 2\alias{redisSort}
 3\title{
 4redisSort
 5}
 6\description{
 7Sort a list, set or sorted set (zset).
 8}
 9\usage{
10redisSort(key, decreasing = FALSE, alpha = FALSE, by = NULL,
11          start = NULL, count = NULL, get = NULL, store = NULL, ...)
12}
13%- maybe also 'usage' for other objects documented here.
14\arguments{
15  \item{key}{
16The key name of the list, set or zset to be sorted.
17}
18  \item{decreasing}{
19Set the direction of the sort.
20}
21  \item{alpha}{
22Lexicographically sort if true, otherwise try numeric sorting.
23}
24  \item{by}{
25The BY option takes a pattern that is used in order
26to generate the key names of the weights used for sorting. Weight key names are
27obtained substituting the first occurrence of * with the actual value of the
28elements on the list. See the Redis documentation for examples.
29}
30  \item{start}{
31Starting index of the sort.
32}
33  \item{count}{
34Number of entries past start to use for the sort.
35}
36  \item{get}{
37Retrieve external keys. See the Redis documentation.
38}
39  \item{store}{
40Store the results in the specified key.
41}
42  \item{...}{ Optional additional arguments.  Specify \code{raw=TRUE} to skip de-serialization of the data.}
43}
44\details{
45Sort the elements contained in the List, Set, or Sorted Set value at key. By
46default sorting is numeric with elements being compared as double precision
47floating point numbers.
48}
49\value{
50A list of sorted values, unless \code{store} is specified in which case 
51the results are stored in the specified key and TRUE is returned.
52}
53\references{
54http://redis.io/commands
55}
56\author{
57B. W. Lewis
58}