search.FileDetail: Searches a list of projects for keyword matches

In booker-tremayne/new-prideR: Explore the Pride Archive in R

Description

Searches a list of projects for keyword matches

Usage

search.FileDetail(
  project.list,
  keywords = "",
  filetype = " ",
  file.size.min = 0,
  file.size.max = 99999999999,
  all = FALSE,
  use.regex = FALSE
)

Arguments

project.list	The list of projects the user wishes to search the files through
keywords	The word or words the user is searching for in files
filetype	The category of file. Categories are described by Pride
file.size.min	The lower range of file memory size
file.size.max	The upper range of file memory size
all	Determines whether the to match using ALL or ANY logic. Defaults to ANY
use.regex	Determines whether the keywords are regex patterns or should be matched literally

Details

This functionality is not built natively into the Pride web service. Searching through a ProjectSummary list will take a long time. For multiple searches on the same ProjectSummary list, it is recommended to create FileDetailList first, then search through that. This can be done by inputting the ProjectSummary list into "get.FileDetailList()". While this function can accept ProjectSummaries, it will always return a FileDetailList. This is to ensure recursive searches are faster.

Value

the FileDetailList list of successful matches

Author(s)

Tremayne Booker

booker-tremayne/new-prideR documentation built on Dec. 19, 2021, 10:48 a.m.