Skip to content

Commit

Permalink
Added information about exported facts.
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcdermott committed Oct 6, 2016
1 parent c5cf45d commit 086bb84
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 2 deletions.
Binary file added assets/Export Button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Exported Fact.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Fact Graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Organization Facts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 26 additions & 2 deletions facts.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ similar among all of your models.
Organization level facts are currently all private and are only available for use in private models.

### Creating & Editing Facts
#### Static Facts

Each fact has a ** value**, **name**, and **hashtag**.

Expand All @@ -35,13 +36,36 @@ the standard distribution options for that range.

The **name** is whatever you want to use to refer to the fact. It is only used for your own reference.

The **hashtag** is what you can use to refer to the fact inside of a function. For instance,
The **hashtag** is what you can use to refer to the fact inside of a metric in a model. As opposed to global facts,
which are referenced with the `@` symbol, organizational facts are referenced via a automatically generated or user-set
hashtag, as shown below:

``= #monthly_revenue / 12 ``
![Organization facts are referenced via the hashtag](./assets/Organization Facts.png)

Facts can be simply added or edited. They are findable on the organizations' page. We suggest being careful with
deleting facts: while this is possible, if you have a model that uses that fact, that model may break.

#### Exported Facts

Facts can also be exported from metrics within private models within your organization. To export a fact from a metric,
simply open the metric sidebar and select 'Export':

![Export a Metric to a Fact via the Metric Sidebar](./assets/Export Button.png)

Only named metrics containing functions can be exported. Once a metric has been exported as a fact, deleting either that
metric or that fact will delete the associated fact. Furthermore, the metric card is marked with an _exported_ symbol in
the upper right corner of the card, as below:

![Exported metrics are specially demarcated](./assets/Exported Fact.png)

Exported facts take on the name of the owning metric, an automatically assigned hashtag based on that name, and the
value of that metric. The resultant facts are kept in-sync with the owning model, even if upstream facts used in the
model change. In this way, you can connect disparate facts together via models that relate one fact to another. You can
explore these dependencies via the _Fact Graph_, accessible on the organization page. The fact graph also will show
which models within your organization use which facts, even if those models do not export facts of their own.

![The fact graph displays the dependency network of your organization's facts.](./assets/Fact Graph.png)

### Using Facts

Facts are simple to use in models. In a function, type the hashtag that represents a fact in order to refer to it.
Expand Down

0 comments on commit 086bb84

Please sign in to comment.