From a856b25033bff46960b460cd3249fadeab73d08e Mon Sep 17 00:00:00 2001 From: pbchase Date: Thu, 13 Jun 2024 21:45:34 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20ctsit/re?= =?UTF-8?q?dcapcustodian@84d14dc7a3e2bf5b26cadd4bfa81896f4370fe99=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- LICENSE-text.html | 2 +- articles/credential-scraping.html | 2 +- articles/custom_rscript.html | 24 ++-- .../delete-erroneous-survey-reminders.html | 2 +- articles/developer_notes.html | 2 +- articles/expire_user_project_rights.html | 2 +- articles/friday-call-demo-setup.html | 2 +- articles/friday-call-demo.html | 2 +- articles/index.html | 2 +- articles/job_logging.html | 18 ++- articles/randomization-management.html | 2 +- authors.html | 6 +- index.html | 2 +- news/index.html | 6 +- pkgdown.yml | 2 +- reference/build_etl_job_log_df.html | 2 +- reference/build_formatted_df_from_result.html | 2 +- reference/connect_to_db.html | 2 +- reference/connect_to_log_db.html | 2 +- reference/connect_to_redcap_db.html | 2 +- reference/convert_schema_to_sqlite.html | 2 +- reference/copy_entire_table_to_db.html | 2 +- reference/create_allocation_rows.html | 2 +- reference/create_randomization_row.html | 2 +- reference/create_test_table.html | 2 +- reference/create_test_tables.html | 2 +- reference/dataframe_to_redcap_dictionary.html | 2 +- reference/dataset_diff.html | 2 +- reference/dataset_diff_test_bar_bang.html | 2 +- reference/dataset_diff_test_user_data.html | 2 +- reference/delete_project.html | 2 +- reference/disable_non_interactive_quit.html | 2 +- ...a_preconfigured_project_in_production.html | 2 +- reference/evaluate_checksums.html | 2 +- reference/expire_user_project_rights.html | 6 +- ...export_allocation_tables_from_project.html | 2 +- ...get_bad_emails_from_individual_emails.html | 2 +- .../get_bad_emails_from_listserv_digest.html | 2 +- ...ails_from_listserv_digest_test_output.html | 2 +- reference/get_current_time.html | 2 +- reference/get_institutional_person_data.html | 2 +- reference/get_job_duration.html | 2 +- reference/get_package_scope_var.html | 2 +- reference/get_project_instance.html | 90 ++++++++++++++ reference/get_project_life_cycle.html | 2 +- reference/get_project_name.html | 90 ++++++++++++++ reference/get_redcap_credentials.html | 2 +- reference/get_redcap_db_connection.html | 2 +- reference/get_redcap_email_revisions.html | 2 +- .../get_redcap_email_revisions_test_data.html | 2 +- reference/get_redcap_emails.html | 2 +- reference/get_redcap_emails_test_data.html | 2 +- reference/get_script_name.html | 2 +- reference/get_script_run_time.html | 2 +- reference/get_table_checksum.html | 2 +- reference/get_test_table_names.html | 2 +- reference/index.html | 22 +++- reference/init_etl.html | 12 +- reference/init_log_con.html | 2 +- reference/is_db_con.html | 2 +- reference/is_on_ci.html | 2 +- reference/log_event_tables.html | 2 +- reference/log_job_debug.html | 2 +- reference/log_job_failure.html | 2 +- reference/log_job_success.html | 2 +- reference/mutate_columns_to_posixct.html | 2 +- .../project_life_cycle_descriptions.html | 2 +- reference/project_purpose_labels.html | 2 +- ...project_purpose_other_research_labels.html | 2 +- reference/project_status_labels.html | 2 +- reference/quit_non_interactive_run.html | 2 +- reference/scrape_user_api_tokens.html | 2 +- reference/send_email.html | 2 +- reference/set_package_scope_var.html | 2 +- reference/set_project_api_token.html | 2 +- reference/set_project_instance.html | 113 ++++++++++++++++++ reference/set_project_name.html | 113 ++++++++++++++++++ reference/set_script_name.html | 2 +- reference/set_script_run_time.html | 4 +- reference/set_super_api_token.html | 2 +- .../suspend_users_with_no_primary_email.html | 2 +- reference/sync_metadata.html | 2 +- reference/sync_table.html | 2 +- reference/sync_table_2.html | 2 +- .../sync_table_test_user_data_result.html | 2 +- .../unnest_job_summary_data_json_object.html | 2 +- .../update_production_allocation_state.html | 2 +- reference/update_redcap_email_addresses.html | 2 +- ...date_redcap_email_addresses_test_data.html | 2 +- reference/user_rights_test_data.html | 2 +- reference/verify_log_connectivity.html | 2 +- reference/verify_log_dependencies.html | 2 +- reference/verify_log_env_variables.html | 2 +- reference/write_allocations.html | 2 +- reference/write_debug_job_log_entry.html | 2 +- reference/write_error_job_log_entry.html | 2 +- reference/write_error_log_entry.html | 2 +- reference/write_info_log_entry.html | 2 +- reference/write_success_job_log_entry.html | 2 +- reference/write_summary_metrics.html | 2 +- reference/write_to_sql_db.html | 2 +- search.json | 2 +- sitemap.xml | 12 ++ 104 files changed, 583 insertions(+), 115 deletions(-) create mode 100644 reference/get_project_instance.html create mode 100644 reference/get_project_name.html create mode 100644 reference/set_project_instance.html create mode 100644 reference/set_project_name.html diff --git a/404.html b/404.html index 46266a1..32740f6 100644 --- a/404.html +++ b/404.html @@ -24,7 +24,7 @@ redcapcustodian - 1.22.2 + 1.23.0 + + + + + +
+
+
+

Fetches the package-scoped value of project_instance

+ Source: R/logging.R +
get_project_instance.Rd
+
+ +
+

Fetches the package-scoped value of project_instance

+
+ +
+

Usage

+ 
get_project_instance()
+
+ + +
+ + +
+

Developed by Philip Chase, Laurence James-Woodley, Kyle Chesney, Michael Bentz.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + diff --git a/reference/get_project_life_cycle.html b/reference/get_project_life_cycle.html index 08cd7a6..5a38db9 100644 --- a/reference/get_project_life_cycle.html +++ b/reference/get_project_life_cycle.html @@ -14,7 +14,7 @@ redcapcustodian - 1.22.2 + 1.23.0 + + + + + +
+
+
+

Fetches the package-scoped value of project_name

+ Source: R/logging.R +
get_project_name.Rd
+
+ +
+

Fetches the package-scoped value of project_name

+
+ +
+

Usage

+ 
get_project_name()
+
+ + +
+ + +
+

Developed by Philip Chase, Laurence James-Woodley, Kyle Chesney, Michael Bentz.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + diff --git a/reference/get_redcap_credentials.html b/reference/get_redcap_credentials.html index 30a875b..b24a402 100644 --- a/reference/get_redcap_credentials.html +++ b/reference/get_redcap_credentials.html @@ -14,7 +14,7 @@ redcapcustodian - 1.22.2 + 1.23.0 + + + + + +
+
+
+

Sets the package-scoped value of project_instance

+ Source: R/logging.R +
set_project_instance.Rd
+
+ +
+

Sets the package-scoped value of project_instance

+
+ +
+

Usage

+ 
set_project_instance(project_instance = "")
+
+ +
+

Arguments

+
project_instance
+

Defaults to NULL. If provided and not NULL, this value is used. +If NULL, the function attempts to fetch the value from the environment variable.

+ +
+
+

Value

+ + +

the package-scoped value of project_instance

+
+ +
+

Examples

+ 
if (FALSE) {
+project_instance <- set_project_instance()
+project_instance <- set_project_instance("project_instance")
+}
+
+
+
+
+ + +
+

Developed by Philip Chase, Laurence James-Woodley, Kyle Chesney, Michael Bentz.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + diff --git a/reference/set_project_name.html b/reference/set_project_name.html new file mode 100644 index 0000000..ba23f9a --- /dev/null +++ b/reference/set_project_name.html @@ -0,0 +1,113 @@ + +Sets the package-scoped value of project_name — set_project_name • redcapcustodian + Skip to contents + + +
+
+
+

Sets the package-scoped value of project_name

+ Source: R/logging.R +
set_project_name.Rd
+
+ +
+

Sets the package-scoped value of project_name

+
+ +
+

Usage

+ 
set_project_name(project_name = "")
+
+ +
+

Arguments

+
project_name
+

Defaults to NULL. If provided and not NULL, this value is used. +If NULL, the function attempts to fetch the value from the environment variable.

+ +
+
+

Value

+ + +

the package-scoped value of project_name

+
+ +
+

Examples

+ 
if (FALSE) {
+project_name <- set_project_name()
+project_name <- set_project_name("project_name")
+}
+
+
+
+
+ + +
+

Developed by Philip Chase, Laurence James-Woodley, Kyle Chesney, Michael Bentz.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + diff --git a/reference/set_script_name.html b/reference/set_script_name.html index 182ddd6..aaab9b0 100644 --- a/reference/set_script_name.html +++ b/reference/set_script_name.html @@ -14,7 +14,7 @@ redcapcustodian - 1.22.2 + 1.23.0