From 39979a1817b31fc361782d98e915a4cc8363eb41 Mon Sep 17 00:00:00 2001
From: "Luke W. Johnston" <lwjohnst@gmail.com>
Date: Fri, 31 May 2024 19:41:31 +0200
Subject: [PATCH] chore: rebuild roxygen documentation

---
 NAMESPACE                       |  3 ++-
 man/builder_table_exporter.Rd   |  3 +--
 man/create_csv_from_database.Rd |  9 +++------
 man/download_data.Rd            |  2 ++
 man/rap_get_path_files.Rd       |  9 ++++++---
 man/rap_get_path_user.Rd        | 17 -----------------
 man/rap_get_path_user_files.Rd  | 17 +++++++++++++++++
 man/upload_data.Rd              |  2 +-
 8 files changed, 32 insertions(+), 30 deletions(-)
 delete mode 100644 man/rap_get_path_user.Rd
 create mode 100644 man/rap_get_path_user_files.Rd

diff --git a/NAMESPACE b/NAMESPACE
index acc2909..500e803 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -17,7 +17,7 @@ export(rap_copy_to)
 export(rap_get_path_database)
 export(rap_get_path_files)
 export(rap_get_path_schema)
-export(rap_get_path_user)
+export(rap_get_path_user_files)
 export(rap_get_path_users)
 export(rap_get_user)
 export(setup_git_config)
@@ -25,4 +25,5 @@ export(setup_ukb_project)
 export(setup_ukb_rap)
 export(subset_rap_variables)
 export(upload_data)
+importFrom(lifecycle,deprecated)
 importFrom(magrittr,"%>%")
diff --git a/man/builder_table_exporter.Rd b/man/builder_table_exporter.Rd
index e7f4899..192e527 100644
--- a/man/builder_table_exporter.Rd
+++ b/man/builder_table_exporter.Rd
@@ -45,9 +45,8 @@ library(dplyr)
 library(stringr)
 library(magrittr)
 rap_variables \%>\%
-  filter(str_detect(rap_variable_name, "\"")) \%>\%
   sample_n(10) \%>\%
-  pull(rap_variable_name) \%>\%
+  pull(id) \%>\%
   builder_table_exporter(project_id = "test", username = "lwj") \%>\%
   cat()
 }
diff --git a/man/create_csv_from_database.Rd b/man/create_csv_from_database.Rd
index 872caa3..939523f 100644
--- a/man/create_csv_from_database.Rd
+++ b/man/create_csv_from_database.Rd
@@ -49,11 +49,8 @@ probably only once at the start of your project. NOTE: This function takes
 \examples{
 \dontrun{
 library(tidyverse)
-read_csv("data-raw/rap-variables.csv") \%>\%
-  pull(variable_name) \%>\%
-  create_csv_from_database()
-# rap_variables \%>\%
-#   pull(field_id) \%>\%
-#   create_csv_from_database(project_id = "mesh", username = "lwjohnst")
+rap_variables \%>\%
+  pull(id) \%>\%
+  create_csv_from_database(project_id = "mesh", username = "lwjohnst")
 }
 }
diff --git a/man/download_data.Rd b/man/download_data.Rd
index 423da1b..6f14b54 100644
--- a/man/download_data.Rd
+++ b/man/download_data.Rd
@@ -26,6 +26,8 @@ download_data(
 Downloads the data file to \verb{data/}.
 }
 \description{
+\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}
+
 Use this function every time you open a new RStudio Session, aka every time you
 use the UKB RAP. We don't want to save the data within the Git repository, so
 you'd need to download it every time you go back to analyzing the data.
diff --git a/man/rap_get_path_files.Rd b/man/rap_get_path_files.Rd
index 1e9690e..4868831 100644
--- a/man/rap_get_path_files.Rd
+++ b/man/rap_get_path_files.Rd
@@ -2,13 +2,16 @@
 % Please edit documentation in R/rap.R
 \name{rap_get_path_files}
 \alias{rap_get_path_files}
-\title{Title}
+\title{Get paths of files and folders based on a given path in the RAP project server.}
 \usage{
 rap_get_path_files(path)
 }
 \arguments{
-\item{path}{}
+\item{path}{The path to search for files and folders.}
+}
+\value{
+A character vector of files and folders.
 }
 \description{
-Title
+Get paths of files and folders based on a given path in the RAP project server.
 }
diff --git a/man/rap_get_path_user.Rd b/man/rap_get_path_user.Rd
deleted file mode 100644
index 678d6eb..0000000
--- a/man/rap_get_path_user.Rd
+++ /dev/null
@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/rap.R
-\name{rap_get_path_user}
-\alias{rap_get_path_user}
-\title{Get the path of a single user within the RAP project server.}
-\usage{
-rap_get_path_user(user)
-}
-\arguments{
-\item{user}{A user's username.}
-}
-\value{
-A character scalar of one users path.
-}
-\description{
-Get the path of a single user within the RAP project server.
-}
diff --git a/man/rap_get_path_user_files.Rd b/man/rap_get_path_user_files.Rd
new file mode 100644
index 0000000..9af67e4
--- /dev/null
+++ b/man/rap_get_path_user_files.Rd
@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/rap.R
+\name{rap_get_path_user_files}
+\alias{rap_get_path_user_files}
+\title{Get the paths of files in a single users folder within the RAP project server.}
+\usage{
+rap_get_path_user_files(user)
+}
+\arguments{
+\item{user}{A user's username.}
+}
+\value{
+A character vector of files in a user's folder.
+}
+\description{
+Get the paths of files in a single users folder within the RAP project server.
+}
diff --git a/man/upload_data.Rd b/man/upload_data.Rd
index 0b0359d..ff8da82 100644
--- a/man/upload_data.Rd
+++ b/man/upload_data.Rd
@@ -26,5 +26,5 @@ upload_data(
 A path to the uploaded data file.
 }
 \description{
-Upload a data file to the RAP.
+\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}
 }