diff --git a/R/helper.POSTapi_download_w_json2df.R b/R/helper.POSTapi_download_w_json2df.R index a399e5b..46ab870 100644 --- a/R/helper.POSTapi_download_w_json2df.R +++ b/R/helper.POSTapi_download_w_json2df.R @@ -2,7 +2,10 @@ #' @importFrom httr POST #' #' @keywords internal - +# These functions are used by +# #1. bold.fetch +# #2. bold.public.search +# # Function 1: Retrieve data using the POST API post.api.res.fetch<-function (base.url, diff --git a/R/helper.gen.comm.mat.R b/R/helper.gen.comm.mat.R index df99090..6d22054 100644 --- a/R/helper.gen.comm.mat.R +++ b/R/helper.gen.comm.mat.R @@ -45,6 +45,9 @@ #' #' @keywords internal #' +# This function is used by +# #1. bold.analyze.diversity +# gen.comm.mat<-function(bold.df, taxon.rank, taxon.name=NULL, diff --git a/R/helper.get.bin.project.dataset.pids.R b/R/helper.get.bin.project.dataset.pids.R index 70253fd..5d5406b 100644 --- a/R/helper.get.bin.project.dataset.pids.R +++ b/R/helper.get.bin.project.dataset.pids.R @@ -1,5 +1,9 @@ -################## Obtain processids for bin_uri, dataset_codes and project codes using GET API ###################### +#' @keywords internal +# Helper functions to obtain processids for bin_uri, dataset_codes and project codes using GET API +# These functions are used by +# #1. bold.fetch +# # Function 1: The function that uses GET to retrieve pids (First a token is generated which is then used for obtaining the processids) bin.dataset.project.pids<-function (get.data.input, diff --git a/R/helper.msa.gen_ape_file.R b/R/helper.msa.gen_ape_file.R index 4a07ece..d469453 100644 --- a/R/helper.msa.gen_ape_file.R +++ b/R/helper.msa.gen_ape_file.R @@ -2,6 +2,9 @@ #' #' @keywords internal #' +# # These functions are used by +# #1. bold.analyze.align +# # Function 1: Function to obtain the multiple sequence alignment from the BCDM dataframe gen.msa.res<-function(df, alignmethod, diff --git a/R/helper.public.search.public_data.R b/R/helper.public.search.public_data.R index 670c7af..756aa2f 100644 --- a/R/helper.public.search.public_data.R +++ b/R/helper.public.search.public_data.R @@ -3,7 +3,9 @@ #' @importFrom dplyr %>% #' @importFrom utils download.file #' @keywords internal - +# This function is used by +# #1. bold.public.search +# fetch.public.data<-function (query) {