Liking cljdoc? Tell your friends :D

coworkingview.core

Offline snapshot of the CoworkingView Price Index.

Figures live in the resource coworkingview/price-index.edn, copied from spec/golden/rates.csv and spec/golden/cities.csv. The index is CC BY 4.0. Keep attribution with any figure you republish. Loading this namespace does not call the network.

Offline snapshot of the CoworkingView Price Index.

Figures live in the resource `coworkingview/price-index.edn`, copied from
spec/golden/rates.csv and spec/golden/cities.csv. The index is CC BY 4.0.
Keep [[attribution]] with any figure you republish. Loading this namespace
does not call the network.
raw docstring

attributionclj

(attribution)

The CC BY 4.0 credit string from the recorded Price Index response.

The text is copied unchanged. Keep it with any figure you republish.

The CC BY 4.0 credit string from the recorded Price Index response.

The text is copied unchanged. Keep it with any figure you republish.
sourceraw docstring

citiesclj

(cities)

Cities in the snapshot, in the recorded order.

Each map uses the columns of the open cities table, including :published. The unpublished fixture row example-town is included and its price fields are nil. Entry prices are Price Index figures, so keep attribution with them.

Cities in the snapshot, in the recorded order.

Each map uses the columns of the open cities table, including `:published`.
The unpublished fixture row `example-town` is included and its price fields
are `nil`. Entry prices are Price Index figures, so keep [[attribution]]
with them.
sourceraw docstring

matches-city?clj

(matches-city? row city)

Whether row is the city named by city.

city is a slug (berlin) or a display name (Abu Dhabi). Comparison ignores case and treats spaces, hyphens and underscores as the same separator. A blank city matches nothing.

Whether `row` is the city named by `city`.

`city` is a slug (`berlin`) or a display name (`Abu Dhabi`). Comparison
ignores case and treats spaces, hyphens and underscores as the same
separator. A blank `city` matches nothing.
sourceraw docstring

rateclj

(rate city product)
(rate city product rows)

The Price Index row for city and product, or nil when it is absent.

city is a slug (berlin) or a display name (Abu Dhabi). Comparison ignores case and treats spaces, hyphens and underscores as the same separator. product is a product code: flex_desk, fix_desk, private_office, day_pass or meeting_room. The same separator rule applies, so flex desk matches flex_desk.

The map uses the columns of the open rates table. :median is the published median. :p25 and :p75 are nil when the index did not publish them. The optional third argument searches rows instead of the bundled snapshot. Keep attribution with any figure you republish.

The Price Index row for `city` and `product`, or `nil` when it is absent.

`city` is a slug (`berlin`) or a display name (`Abu Dhabi`). Comparison
ignores case and treats spaces, hyphens and underscores as the same
separator. `product` is a product code: `flex_desk`, `fix_desk`,
`private_office`, `day_pass` or `meeting_room`. The same separator rule
applies, so `flex desk` matches `flex_desk`.

The map uses the columns of the open rates table. `:median` is the
published median. `:p25` and `:p75` are `nil` when the index did not
publish them. The optional third argument searches `rows` instead of the
bundled snapshot. Keep [[attribution]] with any figure you republish.
sourceraw docstring

snapshotclj

(snapshot)

The bundled Price Index capture.

Keys: :as_of, :license (CC-BY-4.0), :license_url, :attribution, :scope, :source, :rates and :cities. Row keys are the open-table column names. Empty cells are nil. This reads a resource and does not call the network.

The bundled Price Index capture.

Keys: `:as_of`, `:license` (`CC-BY-4.0`), `:license_url`, `:attribution`,
`:scope`, `:source`, `:rates` and `:cities`. Row keys are the open-table
column names. Empty cells are `nil`. This reads a resource and does not
call the network.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close