mermaid_search_my_projects: Search your MERMAID projects

In data-mermaid/mermaidr: Interface to the 'MERMAID' API

Search your MERMAID projects

Description

Search within your MERMAID projects, by project name, country, or tags. Returns metadata on project, including ID, name, countries, number of sites, tags, notes, status, data sharing policies, and when the project was created and last updated. Requires authorization.

Usage

mermaid_search_my_projects(
  name = NULL,
  countries = NULL,
  tags = NULL,
  include_test_projects = FALSE,
  limit = NULL,
  token = mermaid_token()
)

Arguments

name	Project name
countries	Project country. Projects are returned if the countries field contains countries, not just if it is exactly the same. For a list of countries used in MERMAID, see mermaid_countries
tags	Project tags. Projects are returned if the tags field contains tags, not just if it is exactly the same.
include_test_projects	Whether to include test projects. Defaults to FALSE.
limit	Number of records to get. Use NULL (the default) to get all records.
token	API token. Not required for unauthenticated endpoints. Get manually via mermaid_auth or automatically when running a function that requires a token.

Examples

## Not run: 
mermaid_search_my_projects(tags = "WCS Indonesia")
mermaid_search_my_projects(countries = "Indonesia", tags = "Vibrant Oceans")

# The country (or tag) do not have to be exactly the same
# A project is returned if it *contains* the country/tag:
mermaid_search_my_projects(tags = "WCS", limit = 1)[["tags"]]
# [1] "WCS Indonesia; Vibrant Oceans"

# To search all projects (not just yours), use mermaid_search_projects():
mermaid_search_projects(countries = "Fiji")

## End(Not run)

data-mermaid/mermaidr documentation built on Jan. 26, 2025, 12:29 p.m.