Skip to content

Commit e6786e5

Browse files
committed
Fix documentation issues: Update NEWS.md to v1.0.0, fix encoding and heading levels, reorganize images to man/figures, remove Athlytics-introduction vignette
1 parent 2675e23 commit e6786e5

File tree

193 files changed

+3058
-4391
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

193 files changed

+3058
-4391
lines changed

NEWS.md

-5.93 KB

Athlytics 1.0.0 - Major Release: Privacy-First Local Data Processing

Athlytics 1.0.0

This major release transitions from Strava API to local data export processing, prioritizing user privacy and data ownership while eliminating API rate limits and authentication requirements.


aAthlytics 0.1.2

  • CRAN Resubmission: Carefully addressed feedback from CRAN by making detailed updates and modifications for package resubmission. This primarily involved refining examples (e.g., consistently using \dontrun{} as advised) and ensuring metadata files meet all CRAN standards.

aAthlytics 0.1.1

Core Improvement: Enhanced Reliability & Testing with Simulated Data

This significant update enhances package reliability and ease of use by integrating athlytics_sample_data. This enables all examples to run offline and ensures core functionalities have undergone more rigorous, reproducible testing.

Key Changes:

  • Examples & Vignettes: All Roxygen examples and key vignette examples now primarily use athlytics_sample_data for offline execution and clarity. Network-dependent examples are clearly separated in \donttest{} blocks.
  • Test Suite: Fundamentally refactored the test suite to extensively use athlytics_sample_data and mockery, improving test robustness and parameter coverage.
  • Strengthened Package Quality & Compliance: Undertook thorough package validation, leading to key enhancements for overall robustness and adherence to R packaging standards. This involved: ensuring all function examples are correct and reliably executable (notably addressing strava_oauth(...) scenarios for offline/testing contexts); providing accurate and refined documentation for data objects in R/data.R; fixing Roxygen import directives for precise namespace definition; improving help file readability through Rd line width adjustments; and optimizing package data loading by adding LazyData: true to DESCRIPTION.
  • Documentation: Minor improvements to documentation clarity and consistency (e.g., date formatting in plots, explicit naming of data frame arguments in examples).

aAthlytics 0.1.0

Major Changes

  • Decoupling Calculation: Switched from rStrava::get_activity_streams to direct Strava API calls using httr and jsonlite for fetching activity streams in calculate_decoupling. This aims to resolve previous errors but might impact performance and rate limiting.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22

3-
<img src="image.png" alt="Athlytics Logo" width="200"/>
3+
<img src="man/figures/image.png" alt="Athlytics Logo" width="200"/>
44

55
# Athlytics
66

@@ -19,7 +19,7 @@
1919

2020
### 📈 Package Adoption & Growth
2121

22-
<img src="image/Athlytics_Final.png" alt="Athlytics Downloads Growth" width="650"/>
22+
<img src="man/figures/Athlytics_Final.png" alt="Athlytics Downloads Growth" width="650"/>
2323

2424
*Trusted by researchers, coaches, and athletes worldwide*
2525

@@ -172,7 +172,7 @@ plot_acwr(acwr_data, highlight_zones = TRUE)
172172
```
173173

174174
<p align="center">
175-
<img src="analysis_output/01b_acwr_multi_group.png" alt="ACWR Analysis" width="750"/>
175+
<img src="man/figures/01b_acwr_multi_group.png" alt="ACWR Analysis" width="750"/>
176176
</p>
177177

178178
📖 [ACWR Methodology & Validation](https://hezhiang.com/Athlytics/reference/calculate_acwr.html)
@@ -198,7 +198,7 @@ plot_ef(ef_data, add_trend_line = TRUE)
198198
```
199199

200200
<p align="center">
201-
<img src="analysis_output/02b_ef_multi_group.png" alt="Efficiency Factor" width="750"/>
201+
<img src="man/figures/02b_ef_multi_group.png" alt="Efficiency Factor" width="750"/>
202202
</p>
203203

204204
📖 [Efficiency Factor Theory](https://hezhiang.com/Athlytics/reference/calculate_ef.html)
@@ -224,7 +224,7 @@ plot_decoupling(decoupling_data, decouple_metric = "Pace_HR")
224224
```
225225

226226
<p align="center">
227-
<img src="analysis_output/05b_decoupling_multi_group.png" alt="Decoupling Analysis" width="750"/>
227+
<img src="man/figures/05b_decoupling_multi_group.png" alt="Decoupling Analysis" width="750"/>
228228
</p>
229229

230230
📖 [Decoupling Analysis Guide](https://hezhiang.com/Athlytics/reference/calculate_decoupling.html)

_pkgdown.yml

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,12 @@ template:
66

77
navbar:
88
structure:
9-
left: [intro, reference, articles, changelog]
9+
left: [intro, reference, articles, news]
1010
right: [search, github]
1111
components:
1212
articles:
1313
text: Articles
1414
menu:
15-
- text: Getting Started
16-
- text: Introduction to Athlytics
17-
href: articles/Athlytics-introduction.html
18-
- text: -------
19-
- text: Advanced Topics
2015
- text: Advanced Features
2116
href: articles/advanced-features.html
2217

@@ -74,11 +69,6 @@ reference:
7469
- starts_with("athlytics_sample")
7570

7671
articles:
77-
- title: Getting Started
78-
navbar: ~
79-
contents:
80-
- Athlytics-introduction
81-
8272
- title: Advanced Usage
8373
navbar: ~
8474
contents:

docs/404.html

Lines changed: 44 additions & 81 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)