Added information about TO-DO.

habitus-eu · Jan 29, 2024 · 163b713 · 163b713
1 parent e3f859f
commit 163b713
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 7 deletions.
diff --git a/docs/examples/complete.md b/docs/examples/complete.md
@@ -1 +1 @@
-TO-DO...
+{== TO-DO ==}
diff --git a/docs/gis/index.md b/docs/gis/index.md
@@ -30,6 +30,7 @@ remotes::install_github("habitus-eu/hbGIS") # (3)!
 Before using the hbGIS package to process spatiotemporal behaviour patterns, two additional files must be prepared: a linkage and configuration files.
 
 ### 1. Required files for hbGIS analysis
+
 #### Linkage file
 
 The linkage file is a CSV file that contains three specific columns:
@@ -40,21 +41,24 @@ The linkage file is a CSV file that contains three specific columns:
 | `school_id`          | For grouping spatiotemporal information. This means that the school shape (polygon) can be mapped to a group of participants.                     |
 | `class_id`           | For sub-grouping. Participants from the same school have separate results (class-based).                                                          |
 
-An example of a linkage file can be downloaded [here](#).
+An example of a linkage file can be downloaded [here](#). {== TO-DO: Add example file. ==}
 
 #### Configuration file
 
+TODO: Added some text.
+
 | Column             | Description                                                                                                                                       |
 | -------------------| ------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `context`          | palmplusr fields tables (TO-DO: List of contexts...)                                                                                              |
 | `name`             | User specified name of formula                                                                                                                    |
 | `formula`          | Formula (see more at [palmsplur](https://thets.github.io/palmsplusr/articles/article-3-building-formulas.html))                                   |
-| `is_where_field`   | TO-DO..                                                                                                                                           |
-| `after_conversion` | TO-DO..                                                                                                                                           |
+| `is_where_field`   | {== TO-DO ==}                                                                                                                                           |
+| `after_conversion` | {== TO-DO ==}                                                                                                                                           |
 
-An example of a configuration file can be downloaded [here](#).
+An example of a configuration file can be downloaded [here](#). {== TO-DO: Add example file. ==}
 
 ### 2. Analysis
+
 #### Configuration
 
 | Parameter               | Description                                                                                                                                       |

diff --git a/docs/gui/index.md b/docs/gui/index.md
@@ -39,11 +39,16 @@ Upon launching the HabitusGUI application, the user will be prompted to select t
 
 Once the user selects the desired analyses, a help menu appears on the screen. Depending on the selected analysis, the menu recommends suitable packages that are required for the analysis. The user can then modify the packages per the recommendations before proceeding with the analysis.
 
-In the following steps, the user must upload the required files, which may include datasets and [configuration files]() depending on the chosen analysis. Additionally, the user may be required to name the dataset.
+In the following steps, the user must upload the required files, which may include datasets and [configuration files]() depending on the chosen analysis. Additionally, the user may be required to name the dataset. {== TO-DO: Add configuration file ==}
+
+{== TO-DO: Pictures, finish information usage section. ==}
 
 ## Configuration files
+
+{== TO-DO: Added configuration example files. ==}
+
 Examples of configuration files to download include:
 
 1. GGIR (data in [RAW format](#) or in [counts](#))
 2. [hbGPS](#)
-3. [hbGIS](#)
+3. [hbGIS](#)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -92,3 +92,8 @@ markdown_extensions:
   - pymdownx.magiclink
   - pymdownx.details
   - tables
+  - pymdownx.critic
+  - pymdownx.caret
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.tilde