Skip to content

Commit

Permalink
Minor formatting in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sieboldianus committed Dec 11, 2020
1 parent 1d3831c commit e719714
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/input-types.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Input type: file, url, or database?
# Input type: File, URL, or Database?

lbsntransform can read data from different common types of data sources:

Expand Down
11 changes: 6 additions & 5 deletions docs/output-mappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,12 @@ For example:
lbsntransform --include_lbsn_bases hashtag,place,date,community
```

would fill/update entries of the hlldb structures:
- topical.hashtag
- spatial.place
- temporal.date
- social.community
..would fill/update entries of the hlldb structures:

- topical.hashtag
- spatial.place
- temporal.date
- social.community

This name refers to `schema.table`.

Expand Down
13 changes: 6 additions & 7 deletions docs/use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,20 @@ If you're using the command line interface, a common usage of lbsntransform is t
import/convert arbitrary social media data, e.g. from Flickr or Twitter, to a Postgres Database
with the [common lbsn structure](https://lbsn.vgiscience.org/)

The following use cases exist:

1. importing lbsntransform as a package
The following two primary use cases exist:

1. **Importing lbsntransform as a package**
Use this approach to convert data, such as individual posts
retrieved from an API, on-the-fly (in-memory), in your own
python package.

2. using the command line interface (cli) to perform batch conversions

2. **Using the command line interface (cli) to perform batch conversions**
Use this approach if you want to convert batches of data stored as
arbitrary json/csv files, or if you want to convert from a database
with the raw lbsn structure to a database with the privacy-aware hll
format.

For any conversion,
- the input type must be provided, see [input-types](input-types)
- a mapping must exist, see [input-mappings](input-mappings)

- the input type must be provided, see [input-types](/input-types)
- a mapping must exist, see [input-mappings](/input-mappings)

0 comments on commit e719714

Please sign in to comment.