update-microreact-project

Updates a project on a Microreact server.

Arguments

Inputs:

project: The ID (e.g. fCXBPv48KNkm5oZq8UWdHG) or the URL (e.g. https://microreact.org/project/fCXBPv48KNkm5oZq8UWdHG) of an existing project to be updated.

name: The project name. If unspecified, defaults to "Unnamed project".

description: An optional project description in Markdown format.

data: Data in CSV format or a URL linking to a CSV file.

tree: An optional phylogenetic tree in Newick format (.nwk, .newick, .tre, .nhx, or .tree) or a URL linking to a Newick file.

network: An optional network in DOT format or a URL linking to a DOT file.

api: The URL of the Microreact server API. If unspecified, defaults to https://microreact.org/api.

access token: The API access token for a Microreact account. See https://docs.microreact.org/api/access-tokens.

id column: The column name in data that will be used as the unique row ID. If unspecified, defaults to id.

timeline column: The column name which contains the timeline data. If unspecified, defaults to null.

latitude column: The column name which contains latitude values. If unspecified, defaults to null.

longitude column: The column name which contains longitude values. If unspecified, defaults to null.

Output:

id: The ID of the updated project.

url: The URL of the updated project.

Possible use cases

  • Update a Microreact with new data.

Last updated