Skip to content

Commit 517b562

Browse files
committed
updated roxygen tags and documentation to include descriptive labels for @returns
1 parent dff3f6b commit 517b562

File tree

7 files changed

+28
-13
lines changed

7 files changed

+28
-13
lines changed

R/zzz.R

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ NULL
66
#' @description Handles package initialization including loading required datasets
77
#' from GitHub or local fallback files.
88
#' @keywords internal
9+
#' @returns
10+
#' nothing, loads data from external repository that will be needed by other package functions
911
#' @importFrom utils download.file
1012
#' @importFrom tools R_user_dir
1113
#' @noRd
@@ -18,7 +20,7 @@ NULL
1820
critical_datasets <- c("MIT_stops", "lookup_Jul25", "SMART_stops",
1921
"CA_orig_stops", "Temple_stops25")
2022

21-
# Try loading from GitHub first
23+
#load from GitHub repo
2224
loaded_from <- tryCatch({
2325
repo_url <- "https://raw.githubusercontent.com/Reilly-ConceptsCognitionLab/ConversationAlign_Data/main/data/"
2426
temp_dir <- tempdir()

man/corpus_analytics.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/load_github_data.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/prep_dyads.Rd

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

man/read_1file.Rd

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

man/read_dyads.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/summarize_dyads.Rd

Lines changed: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)