Export parse_activity_file and calculate_ef_from_stream functions, fix README YAML parsing, update documentation

Author: HzaCode

NAMESPACE

@@ -13,11 +13,13 @@ export(calculate_acwr)
 export(calculate_acwr_ewma)
 export(calculate_decoupling)
 export(calculate_ef)
+export(calculate_ef_from_stream)
 export(calculate_exposure)
 export(calculate_pbs)
 export(cohort_reference)
 export(flag_quality)
 export(load_local_activities)
+export(parse_activity_file)
 export(plot_acwr)
 export(plot_acwr_comparison)
 export(plot_acwr_enhanced)

R/calculate_ef.R

@@ -327,9 +327,23 @@ calculate_ef <- function(activities_data,
   return(ef_data)
 }
 
-#' Internal: Calculate EF from Stream Data with Steady-State Analysis
-#' @keywords internal
-#' @noRd
+#' Calculate EF from Stream Data with Steady-State Analysis
+#' 
+#' Calculate efficiency factor (EF) from detailed stream data using steady-state analysis.
+#' This function analyzes heart rate and power/pace data to find periods of steady effort
+#' and calculates the efficiency factor for those periods.
+#'
+#' @param stream_data Data frame with stream data (time, heartrate, watts/distance columns)
+#' @param activity_date Date of the activity
+#' @param act_type Activity type (e.g., "Run", "Ride")
+#' @param ef_metric Efficiency metric to calculate ("pace_hr" or "power_hr")
+#' @param min_steady_minutes Minimum duration for steady-state analysis (minutes)
+#' @param steady_cv_threshold Coefficient of variation threshold for steady state
+#' @param min_hr_coverage Minimum heart rate data coverage required
+#' @param quality_control Quality control setting ("off", "flag", "filter")
+#'
+#' @return Data frame with EF calculation results
+#' @export
 calculate_ef_from_stream <- function(stream_data, activity_date, act_type, ef_metric, 
                                    min_steady_minutes, steady_cv_threshold, min_hr_coverage, quality_control) {
 

README.md

@@ -72,7 +72,7 @@ Designed for athletes, coaches, and sports scientists, Athlytics standardizes th
 
 *   ✅ **Reproducible and Shareable**: Because the workflow is self-contained, your analysis scripts are easy to share and will produce the same results every time, making it ideal for reliable, long-term tracking.
 
----
+***
 
 ## 📦 Installation
 
@@ -91,7 +91,8 @@ install.packages("Athlytics")
 remotes::install_github("HzaCode/Athlytics")
 ```
 
----
+***
+
 ### 🚀 Quick Start
 
 
@@ -129,7 +130,7 @@ individual_acwr <- cohort_acwr %>% filter(athlete_id == "A1")
 plot_with_reference(individual = individual_acwr, reference = reference_bands)
 ```
 
----
+***
 
 ## 📊 Core Analyses
 
@@ -162,7 +163,7 @@ Measure your endurance by analyzing how much your heart rate "drifts" upward dur
   <em><a href="https://hezhiang.com/Athlytics/reference/calculate_decoupling.html">Learn more about Decoupling...</a></em>
 </p>
 
----
+***
 
 ## 📝 Citation
 
@@ -178,7 +179,7 @@ If you use **Athlytics** in your research, please cite the software. We also rec
 }
 ```
 
----
+***
 
 ## 🤝 Contributing