create-microreact-project

Creates a Microreact project.

This adaptor creates a new Microreact project each time it runs. To continuously update an existing Microreact project, use update-microreact-project instead.

Arguments

Inputs:

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

description: An optional Markdown description.

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

tree: An optional phylogenetic tree in Newick format or a URL linking to a Newick file. TIP: If you have a NWK file on your computer that you want to use here, import it via the File-to-text adaptor first (leave 'encoding' argument blank).

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: An API access token. See https://docs.microreact.org/api/access-tokens.

id column: The column name that will be used as the 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 map latitude values. If unspecified, defaults to null.

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

Output:

id: The ID of the newly created project.

url: The URL of the newly created project.

Example

Possible use cases

  • Create a new Microreact project to explore and visualize data transformed in Data-flo.

  • Instead of updating an existing Microreact project, create a new one (for version control purposes) and use send-email-message to set the data-flo to send an email to collaborators containing the link to the new project. Add the date in the project name using date-to-text and concatenate-text as inputs to the project name argument.

Last updated