Skip to content

Commit

Permalink
docs: update guide, env example
Browse files Browse the repository at this point in the history
  • Loading branch information
engisalor committed Oct 19, 2023
1 parent 550a2a2 commit d148632
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .env-example
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ SGEX_SERVER=ske
# custom call throttling times (see sgex package docs)
# SGEX_WAIT_DICT="<{JSON_DICT}>"

# URL for generating external links
# SERVER_URL=https://app.sketchengine.eu

# docker
IMAGE="quartz:latest"
CONTAINER="quartz"
Expand Down
23 changes: 23 additions & 0 deletions config/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,29 @@ Graphs are made with [plotly](https://plotly.com/) and have interactive features
- Select/deselect corpora in the legend
- Other features are shown on the top right of a graph when hovering over it

#### Summary table

The summary table can be shown/hidden with the spreadsheet icon next to the `settings` button.

| Column | Description |
|-|-|
| query | Query as written in the `search` bar |
| cql | CQL representation of the query |
| corpus | Current corpus |
| attribute | Current attribute |
| n attr. | Number of text types collected: if many exist, only the top `N` are shown to prevent the app from freezing |
| frq corp. | Occurrences in the whole corpus: the absolute number of times a query appears|
| frq attr. | Sum of occurrences in each attribute: when an attribute is single-value, the sum of all occurrences across text types generally equals `frq. corp.`; when an attribute is multivalue, this can exceed `freq. corp.` (because an occurrence can be shared by multiple text types) |
| fpm corp. | Frequency per million tokens in the whole corpus |
| M rel % | Mean relative density in text types |
| M reltt | Mean relative density per million in text types |
| M fpm | Mean frequency per million in text types |
| M frq | Mean occurrences in text types |

#### Data point URL generation

If activated, this feature generates a URL to the Sketch Engine GUI when a specific data point is clicked. Once the point is selected, click the link icon on the top right of the graph to open a new tab.

#### Advanced queries

*For custom search behaviors*
Expand Down

0 comments on commit d148632

Please sign in to comment.