Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If the query produces large amounts of data (>10,000 observations/rows), the best way to extract the data is using the the code snippet produced after selecting the API button (blue star). Here we see that a code generator appears with the data query……. dataset and observable properties and the user has the option to customise the programming language, variant and output format.

...

In this example , we have selected the programming language R, CSV output and httr variant. Now we can copy the code snippet by pressing the copy snippet button(blue star). In R studio, we can paste this snippet.

Info

It is important to note that you will need to enter your own individual API-key into the code. All API endpoints need a system generated API Key to access and retrieve data. Users can create API Key by visiting their TERN Account.

Code Block
languager
library(httr)

## you will need to enter your own individaul API key ##
headers = c(
  'X-Api-Key' = 'your-api-key',
  'Content-Type' = 'application/json'
)

body = '{
  "query": {
    "dataset": [
      "http://linked.data.gov.au/dataset/tern-ecosystem-processes"
    ],
    "observed_property": [
      "http://linked.data.gov.au/def/tern-cv/56195246-ec5d-4050-a1c6-af786fbec715",
      "http://linked.data.gov.au/def/tern-cv/5701d307-bbea-415a-8857-fbf27d5b93ed",
      "http://linked.data.gov.au/def/tern-cv/c3d26c6f-91b7-4627-91e6-2147fa44ad03",
      "http://linked.data.gov.au/def/tern-cv/c3111898-8404-4306-9599-e7866a749de7"
    ]
  }
}';

res <- VERB("POST", url = "https://ecoplots.tern.org.au/api/v1.0/data/tern-ecosystem-processes?dformat=csv", body = body, add_headers(headers))

## "cat" converts arguments to character strings, concatenates them, separating them by the given sep= string.
cat(content(res, 'text'))

Once this code has been run, we can now create a dataset and inspect the output.

Code Block
languager
## create dataframe called "biomass_DF"
biomass_DF <- read.table(text = content(res, 'text'), sep =",", header = TRUE, stringsAsFactors = FALSE)

## explore dataframe
head(biomass_DF)

We now have a dataframe that we can work with that contains The output below show that site information, date of surveys, scientific names of plant species, stem diameter and height, above ground biomass and links to the methods used to obtain these values.

...

Another option for when the data queried is <10,000 observations, is to select the Execute Data Query button (blue star) . In the below example, we will use the same dataset, yet only select the above ground biomass observable property.

Image Added

After selecting the (blue star) button, we are presented with the data in a text output.

...

We can inspect the data by pressing the view button (blue star)

...

Now we can copy the data by pressing the copy button (blue star) and paste directly into an excel spreadsheet:

...

To convert the text to columns, following these steps:

  1. Highlight the column that contains your list.

  2. Go to Data > Text to Columns.

  3. Choose Delimited. Click Next.

  4. Choose Comma. Click Next.

  5. Choose General or Text, whichever you prefer.

  6. Leave Destination as is, or choose another column. Click Finish.

...