api_projects_filter: Filter projects

View source: R/api_projects.R

api_projects_filterR Documentation

Filter projects

Description

Filter projects

Usage

api_projects_filter(
  title = NULL,
  instrument = NULL,
  with_manager_role = FALSE,
  include_all = FALSE
)

Arguments

title

string to look for in the project title.

instrument

string to look for in the project's instrument.

with_manager_role

boolean, when TRUE, show only projects I can manage.

include_all

search all projects, not just the ones I am registered in.

Value

A list of project objects.

See Also

Other projects: api_project_create(), api_project_delete(), api_project_update(), api_project()

Examples

# show all my projects
api_projects_filter()
# show all projects with "Tara" in the title
api_projects_filter("tara", include_all=TRUE)
# show all projects using the ZooScan
api_projects_filter(instrument="zooscan", include_all=TRUE)

jiho/ecotaxar documentation built on Jan. 16, 2024, 12:26 a.m.