corrected versioning and 'includeInactive' docs

README.md

@@ -1,11 +1,11 @@
-# HDFORCE <img src="docs/img/hdlogo_sm.png" align="right" alt="" width="120" />
+# HDFORCE v1.1.0 <img src="docs/img/hdlogo_sm.png" align="right" alt="" width="120" />
 
 **Get your data from the Hawkin Dynamics API**
 
 <!-- badges: start -->
-![Static Badge](https://img.shields.io/badge/release-v1.0.2-blue)
+![Static Badge](https://img.shields.io/badge/release-v1.1.0-blue)
 ![Static Badge](https://img.shields.io/badge/OS_and_Py_Version_Tests-pass-success)
-![Static Badge](https://img.shields.io/badge/last_commit-2024--05--06-blue)
+![Static Badge](https://img.shields.io/badge/last_commit-2024--07--30-blue)
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![lifecycle](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://www.tidyverse.org/lifecycle/#stable)
 [![license](https://img.shields.io/badge/license-MIT%20+%20file%20LICENSE-lightgrey.svg)](https://choosealicense.com/)

docs/About/changelog.md

@@ -1,9 +1,10 @@
 # Changelogs
 
-## hdforce v1.0.2
+## hdforce v1.1.0
 
 * Additions of CreateAthlete and UpdateAthlete functions
-* Expansion of GetTests function with deprecation of GetTests... variations
+* Expansion of GetTests function to include 'team', 'group', type', and 'athlete' arguments
+* Deprecation of GetTestsAth, GetTestsType, GetTestsTeam, and GetTestsGroup
 
 ## hdforce v1.0.01
 

docs/Functions/GetTests.md

@@ -18,7 +18,7 @@ __`teamId`__: _(str)_ A single team ID, tuple or list of team IDs to receive tes
 
 __`groupId`__: _(str)_ A single group ID, tuple or list of group IDs to receive tests from specific groups.
 
-__`includeInactive`__: _(bool)_ If True, only active tests are fetched. If False, all tests including inactive ones are fetched. Default is True.
+__`includeInactive`__: _(bool)_ Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
 ### Returns
 A Pandas DataFrame containing details of the test trial, with columns:

docs/Functions/GetTestsAth.md

@@ -15,7 +15,7 @@ __`to_`__: _(int)_ Unix timestamp specifying the end time until which tests shou
 
 __`sync`__: _(bool)_ If True, the function fetches updated and newly created tests to synchronize with the database. Default is False.
 
-__`includeInactive`__: _(bool)_ If True, only active tests are fetched. If False, all tests including inactive ones are fetched. Default is True.
+__`includeInactive`__: _(bool)_ Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
 ### Returns
 A Pandas DataFrame containing details of the test trial, with columns:

docs/Functions/GetTestsGroup.md

@@ -15,7 +15,7 @@ __`to_`__: _(int)_ Unix timestamp specifying the end time until which tests shou
 
 __`sync`__: _(bool)_ If True, the function fetches updated and newly created tests to synchronize with the database. Default is False.
 
-__`includeInactive`__: _(bool)_ If True, only active tests are fetched. If False, all tests including inactive ones are fetched. Default is True.
+__`includeInactive`__: _(bool)_ Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
 ### Returns
 A Pandas DataFrame containing details of the test trial, with columns:

docs/Functions/GetTestsTeam.md

@@ -15,7 +15,7 @@ __`to_`__: _(int)_ Unix timestamp specifying the end time until which tests shou
 
 __`sync`__: _(bool)_ If True, the function fetches updated and newly created tests to synchronize with the database. Default is False.
 
-__`includeInactive`__: _(bool)_ If True, only active tests are fetched. If False, all tests including inactive ones are fetched. Default is True.
+__`includeInactive`__: _(bool)_ Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
 ### Returns
 A Pandas DataFrame containing details of the test trial, with columns:

docs/UserGuide/GetData.md

@@ -10,7 +10,7 @@ While the purpose of the package is to help with accessing data specific to your
 
 Every organization has data specific to them. With that, these entities will have unique IDs. It is important to have these IDs available to make the most of your test calls.
 
-* `GetAthletes()` - Get the athletes for an account. Inactive players will only be included if `inactive` parameter is set to TRUE. The response will be a data frame containing the athletes that match this query.
+* `GetAthletes()` - Get the athletes for an account. Inactive players will only be included if `includeInactive` parameter is set to TRUE. The response will be a data frame containing the athletes that match this query.
 * `GetTeams()` - Get the team names and IDs for all the teams in the org. The response will be a data frame containing the teams that are in the organization.
 * `GetGroups()` - Get the group names and IDs for all the groups in the org. The response will be a data frame containing the groups that are in the organization.
 * `GetTags()` - Get the tag names, IDs, and descriptions for tags created by users in your org. The response will be a data frame.
@@ -27,15 +27,15 @@ value you will receive every test. This parameter is best suited for bulk export
 you will receive every test from the beginning of time or the optionally supplied `from_`
 parameter. This parameter is best suited for bulk exports of historical data
 * `sync` = The result set will include updated and newly created tests, following the time constraints of `from_` and `to_`. This parameter is best suited to keep your database in sync with the Hawkin database. It cannot and should not be used to fetch your entire database. A recommended strategy would be to have a job that runs on a short interval e.g. every five minutes that sends the `lastSyncTime` that it received as the `from_` parameter with `sync=True`.
-* `active` = If True, only active tests are fetched. If False, all tests including inactive ones are fetched. The default is set to True.
+* `includeInactive` = Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
 #### Get Test Function
 
 > As of July 10, 2024, `GetTestsAth`, `GetTestsType`, `GetTestsTeam`, and `GetTestsGroup` 
 > have been deprecated for the preferred use of `GetTests`. This function will be fully 
 > superseded Jan 01, 2025 12:00:00.
 
-* `GetTests()` - The primary function to call tests is `get_tests`. This is a base request for tests that, as of 2024-07-10, accepts all arguments : 'from', 'to', 'sync', 'active', 'athleteId', 'testTypeId', 'teamId', and 'groupId'. Using this function, you have complete control of the tests being requested from the cloud. It is important to understand that requests can **NOT** include any combination of 'athleteId', 'testTypeId', 'teamId', or 'groupId'. This will result in and error. Any of these arguments **CAN** be used with 'from', 'to', 'active', and 'sync'.
+* `GetTests()` - The primary function to call tests is `get_tests`. This is a base request for tests that, as of 2024-07-10, accepts all arguments : 'from', 'to', 'sync', 'includeInactive', 'athleteId', 'testTypeId', 'teamId', and 'groupId'. Using this function, you have complete control of the tests being requested from the cloud. It is important to understand that requests can **NOT** include any combination of 'athleteId', 'testTypeId', 'teamId', or 'groupId'. This will result in and error. Any of these arguments **CAN** be used with 'from', 'to', 'active', and 'sync'.
 * `GetTestsAth()` - Get only tests of the specified athlete from your organization. You can specify a time frame `from_`, or `to_`, which the tests should come (or be synced). Response will be a data frame containing the trials from the athlete, within the time range (if specified).
 * `GetTestsType()` - Get only tests of the specified test type from your organization. You can specify a time frame `from_`, or `to_`, which the tests should come (or be synced). Response will be a data frame containing the trials from that test type, within the time range (if specified).
 * `GetTestsTeam()` - Get only tests of the specified teams from your organization. Requires a `teamId` argument, which expects a text string, list or tuple (max of 10 teams). You can specify a time frame `from_`, or `to_`, which the tests should come (or be synced). Response will be a data frame containing the trials from those teams, within the time range (if specified).

hdforce/GetTests.py

@@ -38,7 +38,7 @@ def GetTests(from_=None, to_=None, sync=False, athleteId=None, typeId=None, team
         A single group ID or a comma-separated string of group IDs to receive tests from specific groups.
 
     includeInactive : bool, optional
-        If True, only active tests are fetched. If False, all tests including inactive ones are fetched. Default is True.
+        Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
     Returns
     -------

hdforce/GetTestsAth.py

@@ -32,7 +32,7 @@ def GetTestsAth(athleteId: str, from_: int = None, to_: int = None, sync: bool =
         If True, the function fetches updated and newly created tests to synchronize with the Hawkin database. Default is False.
 
     includeInactive : bool, optional
-        If False, only active tests are fetched. If True, all tests including inactive ones are fetched. Default is False.
+        Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
     Returns
     -------

hdforce/GetTestsGroup.py

@@ -32,7 +32,7 @@ def GetTestsGroup(groupId: str, from_: int = None, to_: int = None, sync: bool =
         If True, the function fetches updated and newly created tests to synchronize with the database. Default is False.
 
     includeInactive : bool, optional
-        If False, only active tests are fetched. If True, all tests including inactive ones are fetched. Default is False.
+        Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
     Returns
     -------

hdforce/GetTestsTeam.py

@@ -31,7 +31,7 @@ def GetTestsTeam(teamId: str, from_: int = None, to_: int = None, sync: bool = F
         If True, the function fetches updated and newly created tests to synchronize with the database. Default is False.
 
     includeInactive : bool, optional
-        If False, only active tests are fetched. If True, all tests including inactive ones are fetched. Default is False.
+        Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
     Returns
     -------

hdforce/GetTestsType.py

@@ -32,7 +32,7 @@ def GetTestsType(typeId: str, from_: int = None, to_: int = None, sync: bool = F
         If True, the function fetches updated and newly created tests to synchronize with the database. Default is False.
 
     includeInactive : bool, optional
-        If False, only active tests are fetched. If True, all tests including inactive ones are fetched. Default is False.
+        Default to False, where only active tests are returned. If True, all tests including inactive ones are returned.
 
     Returns
     -------