Arguments and Usage¶

Usage¶

usage: tagmaps [-h] [--version] [-s SOURCE] [-r] [-e EPSG] [-t] [-p] [-c] [-o]
               [-m] [-w] [-i SHAPEFILE_INTERSECT]
               [--shapefile_exclude SHAPEFILE_EXCLUDE] [-n]
               [--stoplist_emoji STOPLIST_EMOJI]
               [--stoplist_tags STOPLIST_TAGS] [--stoplist_user STOPLIST_USER]
               [--stoplist_places STOPLIST_PLACES]
               [--selectionlist_emoji SELECTIONLIST_EMOJI]
               [--selectionlist_tags SELECTIONLIST_TAGS] [-b]
               [--statistics_only] [-d CLUSTER_CUT_DISTANCE]
               [-l LIMIT_BOTTOM_USERCOUNT] [-g] [-a] [-f FILTER_ORIGIN] [-v]
               [-x MAX_ITEMS] [-q OUTPUT_FOLDER] [-j INPUT_FOLDER]
               [-k CONFIG_FOLDER] [-u LOAD_INTERMEDIATE] [--mapnik_export]

Arguments¶

Quick reference table¶

Short	Long	Default	Description
`-h`	`--help`		show this help message and exit
	`--version`		show program's version number and exit
`-s`	`--source`	`lbsn`	Specify type of source of data. This is needed to read data. Defaults to 'lbsn'.
`-r`	`--disable_remove_longtail`		This will disable exclusion of tags that are used by only a small number of users
`-e`	`--epsg`	`None`	If provided, will overwrite auto EPSG code
`-t`	`--disable_cluster_tags`		Disable cluster tag locationsNo clusters will be generated per distinct tag.
`-p`	`--disable_cluster_locations`		Disable cluster of post locations
`-c`	`--local_saturation_check`		Will attempt to exclude any tags that are (over)used at above a certain percentage of locations in processing extent. This may improve legibility of tag maps at larger scales
`-o`	`--disable_cluster_emoji`		Disable cluster of emoji in addition to tags.
`-m`	`--topic_modeling`		This will used topic modeling to detect groups of tags (based on Latent Dirichlet Allocation). [Not fully implemented: currently, if this flag is set, tagmaps will output a list of merged terms per user which can be used in topic modeling, e.g. Latent Dirichlet Allocation algorithms]
`-w`	`--disable_write_cleaneddata`		This will disable write out of a file limited to the data that will be used for tag clustering (filtered based on stoplists, clipped boundary, minimum user threshold etc.)
`-i`	`--shapefile_intersect`	`None`	Provide a relative path to a shapefile to clip data prior to clustering. The shapefile must be projected to WGS1984 (4326) Projection. Multipart shapefiles are supported, but be careful with polygon holes: it is recommended to exclude polygon holes with a separate shapefile using the --shapefile_exclude flag.
	`--shapefile_exclude`	`None`	Provide a relative path to a shapefile to exclude data prior to clustering. In case --shapefile_intersect is also used, the exclusion here applies after inclusion.
`-n`	`--ignore_stoplists`		Set this flag to ignore any stoplists, even if available/supplied. This is useful if files that are places in 00_Config folder must be temporarily ignored.
	`--stoplist_emoji`	`None`	Supply a relative path to a text file containing emoji to ignore during emoji clustering. Format: one entry per line.
	`--stoplist_tags`	`None`	Supply a relative path to a text file containing terms to ignore during tag clustering. This list is supplemental to 00_Config/SortOutAlways.txt, if such file exists. Format: one entry per line.
	`--stoplist_user`	`None`	Supply a relative path to a text file containing user (guids) to ignore during tag clustering. Format: one entry per line.
	`--stoplist_places`	`None`	Supply a relative path to a text file containing places (guids) to ignore during tag clustering. This list is supplemental to 00_Config/SortOutPlaces.txt, if such file exists. Format: one entry per line.
	`--selectionlist_emoji`	`None`	Supply a relative path to a text file containing emoji, as a positive filter list for selecting a subset of emoji to focus on. Format: one entry per line.
	`--selectionlist_tags`	`None`	Supply a relative path to a text file containing tags, as a positive filter list for selecting a subset of tags to focus on. Format: one entry per line.
`-b`	`--ignore_place_corrections`		Set this flag to ignore place corrections, even if available, supplied.
	`--statistics_only`		Do not cluster, only read input data and output statistics. Suitable to get an overview of input data.
`-d`	`--cluster_cut_distance`	`None`	Provide a cluster cut distance (in meters) where the clustering will be stopped. This will override the auto detection of cluster distance.
`-l`	`--limit_bottom_usercount`	`5`	Remove all tags that are used by less than x photographers.
`-g`	`--disable_write_gis_comp_line`		Disables writing placeholder entry after headerline for avoiding GIS import format issues. Some GIS programs will decide format of columns based on the first data line in a CSV. This setting makes sure there're no empty fields in the first line.
`-a`	`--auto_mode`		If set, no user input will be requested during processing. This flag is suitable if you're running in a command line only environment (WSL) that cannot use the tKinter GUI.
`-f`	`--filter_origin`	`None`	If provided, will filter input data based on origin_id column and the value provided.
`-v`	`--verbose`		Increase output verbosity
`-x`	`--max_items`	`1000`	Number of distinct items to process
`-q`	`--output_folder`	`02_Output`	Relative path to output folder
`-j`	`--input_folder`	`01_Input`	Relative path to input folder
`-k`	`--config_folder`	`00_Config`	Relative path to config folder
`-u`	`--load_intermediate`	`None`	A (relative) path to load from intermediate (cleaned) data
	`--mapnik_export`		If enabled, emoji and tags will be exported together, in a single shapefile, to be used in the Mapnik renderer. Unlike the default output, for ESRI ArcGIS/ArcPro, where emoji need to be written to a separate file, to be joined later - due to a bug in the ESRI software that continues to exists.

`-h`, `--help`¶

show this help message and exit

`--version`¶

show program's version number and exit

`-s`, `--source`¶

(Default: lbsn)

Specify type of source of data. This is needed to read data. Defaults to 'lbsn'.

`-r`, `--disable_remove_longtail`¶

This will disable exclusion of tags that are used by only a small number of users

`-e`, `--epsg`¶

(Default: None)

If provided, will overwrite auto EPSG code

`-t`, `--disable_cluster_tags`¶

Disable cluster tag locationsNo clusters will be generated per distinct tag.

`-p`, `--disable_cluster_locations`¶

Disable cluster of post locations

`-c`, `--local_saturation_check`¶

Will attempt to exclude any tags that are (over)used at above a certain percentage of locations in processing extent. This may improve legibility of tag maps at larger scales

`-o`, `--disable_cluster_emoji`¶

Disable cluster of emoji in addition to tags.

`-m`, `--topic_modeling`¶

This will used topic modeling to detect groups of tags (based on Latent Dirichlet Allocation). [Not fully implemented: currently, if this flag is set, tagmaps will output a list of merged terms per user which can be used in topic modeling, e.g. Latent Dirichlet Allocation algorithms]

`-w`, `--disable_write_cleaneddata`¶

This will disable write out of a file limited to the data that will be used for tag clustering (filtered based on stoplists, clipped boundary, minimum user threshold etc.)

`-i`, `--shapefile_intersect`¶

(Default: None)

Provide a relative path to a shapefile to clip data prior to clustering. The shapefile must be projected to WGS1984 (4326) Projection. Multipart shapefiles are supported, but be careful with polygon holes: it is recommended to exclude polygon holes with a separate shapefile using the --shapefile_exclude flag.

`--shapefile_exclude`¶

(Default: None)

Provide a relative path to a shapefile to exclude data prior to clustering. In case --shapefile_intersect is also used, the exclusion here applies after inclusion.

`-n`, `--ignore_stoplists`¶

Set this flag to ignore any stoplists, even if available/supplied. This is useful if files that are places in 00_Config folder must be temporarily ignored.

`--stoplist_emoji`¶

(Default: None)

Supply a relative path to a text file containing emoji to ignore during emoji clustering. Format: one entry per line.

`--stoplist_tags`¶

(Default: None)

Supply a relative path to a text file containing terms to ignore during tag clustering. This list is supplemental to 00_Config/SortOutAlways.txt, if such file exists. Format: one entry per line.

`--stoplist_user`¶

(Default: None)

Supply a relative path to a text file containing user (guids) to ignore during tag clustering. Format: one entry per line.

`--stoplist_places`¶

(Default: None)

Supply a relative path to a text file containing places (guids) to ignore during tag clustering. This list is supplemental to 00_Config/SortOutPlaces.txt, if such file exists. Format: one entry per line.

`--selectionlist_emoji`¶

(Default: None)

Supply a relative path to a text file containing emoji, as a positive filter list for selecting a subset of emoji to focus on. Format: one entry per line.

`--selectionlist_tags`¶

(Default: None)

Supply a relative path to a text file containing tags, as a positive filter list for selecting a subset of tags to focus on. Format: one entry per line.

`-b`, `--ignore_place_corrections`¶

Set this flag to ignore place corrections, even if available, supplied.

`--statistics_only`¶

Do not cluster, only read input data and output statistics. Suitable to get an overview of input data.

`-d`, `--cluster_cut_distance`¶

(Default: None)

Provide a cluster cut distance (in meters) where the clustering will be stopped. This will override the auto detection of cluster distance.

`-l`, `--limit_bottom_usercount`¶

(Default: 5)

Remove all tags that are used by less than x photographers.

`-g`, `--disable_write_gis_comp_line`¶

Disables writing placeholder entry after headerline for avoiding GIS import format issues. Some GIS programs will decide format of columns based on the first data line in a CSV. This setting makes sure there're no empty fields in the first line.

`-a`, `--auto_mode`¶

If set, no user input will be requested during processing. This flag is suitable if you're running in a command line only environment (WSL) that cannot use the tKinter GUI.

`-f`, `--filter_origin`¶

(Default: None)

If provided, will filter input data based on origin_id column and the value provided.

`-v`, `--verbose`¶

Increase output verbosity

`-x`, `--max_items`¶

(Default: 1000)

Number of distinct items to process

`-q`, `--output_folder`¶

(Default: 02_Output)

Relative path to output folder

`-j`, `--input_folder`¶

(Default: 01_Input)

Relative path to input folder

`-k`, `--config_folder`¶

(Default: 00_Config)

Relative path to config folder

`-u`, `--load_intermediate`¶

(Default: None)

A (relative) path to load from intermediate (cleaned) data

`--mapnik_export`¶

If enabled, emoji and tags will be exported together, in a single shapefile, to be used in the Mapnik renderer. Unlike the default output, for ESRI ArcGIS/ArcPro, where emoji need to be written to a separate file, to be joined later - due to a bug in the ESRI software that continues to exists.

Arguments and Usage¶

Usage¶

Arguments¶

Quick reference table¶

-h, --help¶

--version¶

-s, --source¶

-r, --disable_remove_longtail¶

-e, --epsg¶

-t, --disable_cluster_tags¶

-p, --disable_cluster_locations¶

-c, --local_saturation_check¶

-o, --disable_cluster_emoji¶

-m, --topic_modeling¶

-w, --disable_write_cleaneddata¶

-i, --shapefile_intersect¶

--shapefile_exclude¶

-n, --ignore_stoplists¶

--stoplist_emoji¶

--stoplist_tags¶

--stoplist_user¶

--stoplist_places¶

--selectionlist_emoji¶

--selectionlist_tags¶

-b, --ignore_place_corrections¶

--statistics_only¶

-d, --cluster_cut_distance¶

-l, --limit_bottom_usercount¶

-g, --disable_write_gis_comp_line¶

-a, --auto_mode¶

-f, --filter_origin¶

-v, --verbose¶

-x, --max_items¶

-q, --output_folder¶

-j, --input_folder¶

-k, --config_folder¶

-u, --load_intermediate¶

--mapnik_export¶

`-h`, `--help`¶

`--version`¶

`-s`, `--source`¶

`-r`, `--disable_remove_longtail`¶

`-e`, `--epsg`¶

`-t`, `--disable_cluster_tags`¶

`-p`, `--disable_cluster_locations`¶

`-c`, `--local_saturation_check`¶

`-o`, `--disable_cluster_emoji`¶

`-m`, `--topic_modeling`¶

`-w`, `--disable_write_cleaneddata`¶

`-i`, `--shapefile_intersect`¶

`--shapefile_exclude`¶

`-n`, `--ignore_stoplists`¶

`--stoplist_emoji`¶

`--stoplist_tags`¶

`--stoplist_user`¶

`--stoplist_places`¶

`--selectionlist_emoji`¶

`--selectionlist_tags`¶

`-b`, `--ignore_place_corrections`¶

`--statistics_only`¶

`-d`, `--cluster_cut_distance`¶

`-l`, `--limit_bottom_usercount`¶

`-g`, `--disable_write_gis_comp_line`¶

`-a`, `--auto_mode`¶

`-f`, `--filter_origin`¶

`-v`, `--verbose`¶

`-x`, `--max_items`¶

`-q`, `--output_folder`¶

`-j`, `--input_folder`¶

`-k`, `--config_folder`¶

`-u`, `--load_intermediate`¶

`--mapnik_export`¶