Skip to content

Commit

Permalink
minor changes to readme and faqs
Browse files Browse the repository at this point in the history
updated information in faqs, and added an extra faq

fixed typo in readme
  • Loading branch information
tmesaglio committed Oct 22, 2024
1 parent 0d17d64 commit 9658b21
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 16 deletions.
31 changes: 17 additions & 14 deletions R/ui.R
Original file line number Diff line number Diff line change
Expand Up @@ -219,14 +219,14 @@ ui <- function(){
h5("Longitude:"), verbatimTextOutput("long"),
h5("Accuracy (m):"), verbatimTextOutput("accuracy")
),
tabPanel("FAQs",
tabPanel("About",
h2("Frequently Asked Questions"),

h4("1. What does this app do?"),
p("This app allows users to explore biodiversity across Australia. After selecting a location and a taxonomic group and, the app will generate a species list."),

h4("2. Which taxonomic groups can I generate lists for?"),
p("You can generate lists for marsupials, plants, dragonflies + damselflies (Odonata), butterflies (Papilionoidea) and cicadas."),
p("You can generate lists for marsupials, plants, dragonflies + damselflies (Odonata), butterflies (Papilionoidea) and cicadas. We have also included snakes and lizards (Squamata) from Spain and arachnids from France as extra demos."),

h4("3. What is a KML file?"),
p("KML stands for Keyhole Markup Language. A KML file stores geographic data and features, and allows these features to be displayed on a map in geospatial software such as ", tags$a(href = "https://earth.google.com/", "Google Earth ")),
Expand All @@ -240,22 +240,25 @@ ui <- function(){
h4("6. Can I search for any location in Australia?"),
p("You can search anywhere in Australia, including external territories such as Norfolk Island or Christmas Island, or Australian waters."),

h4("7. Where do the data come from?"),
h4("7. Can I search for locations outside of Australia?"),
p("Yes, but restrictions apply. The best way to adapt infinitylists for other countries is to install and run a local version of infinitylists, and then run our vignette (see the README at https://github.com/traitecoevo/infinitylists for more guidance."),

h4("8. Where do the data come from?"),
p("All data are extracted from the Atlas of Living Australia (ALA), Australia's ", tags$a(href = "https://www.ala.org.au", "national biodiversity database.")),

h4("8. Which data sources within the ALA are included?"),
h4("9. Which data sources within the ALA are included?"),
p("The app generates lists from two data sources, both of which are associated with some kind of voucher, i.e., records that are 'verifiable'. First, all records associated with a physical voucher stored in an Australian institution (such as herbaria and museums) are included for the voucher type 'Collection'. Second, all Australian records from the online citizen science platform iNaturalist that have qualified to enter the ALA are included for the voucher types 'Photograph' and 'Recording'."),

h4("9. What does the buffer do?"),
h4("10. What does the buffer do?"),
p("Selecting a buffer includes additional species that have not been recorded within the main target area, but have been seen in the immediate surrounding area up to the defined radius."),

h4("10. Which taxonomic trees does the app use?"),
h4("11. Which taxonomic trees does the app use?"),
p("The species names presented in the app follow the taxonomic trees used by the ALA. For plants, names are taken from the ", tags$a(href = "https://biodiversity.org.au/nsl/services/search/taxonomy", "Australian Plant Census "), "and for animals, names are taken from the ", tags$a("Australian Faunal Directory ", href = "https://biodiversity.org.au/afd/home"), "with minor exceptions for both"),

h4("11. Are records only included in the app if they are identified to species?"),
h4("12. Are records only included in the app if they are identified to species?"),
p("Yes, any records that are identified to a taxonomic level coarser than species will not be retrieved by the app. Also, any records identified to an infraspecific level will only have the species identification displayed within the app."),

h4("12. Are any other records excluded from the app?"),
h4("13. Are any other records excluded from the app?"),
p("Yes, the following types of record are excluded: "),
tags$ol(
tags$li("iNaturalist records with a copyright license of All Rights Reserved"),
Expand All @@ -265,19 +268,19 @@ ui <- function(){
),
p("More information on ALA spatial issues can be found ", tags$a("here", href = "https://support.ala.org.au/support/solutions/articles/6000240256-getting-started-with-the-data-quality-filters")),

h4("13. Does the app reveal the location of species with sensitive locations?"),
h4("14. Does the app reveal the location of species with sensitive locations?"),
p("Species with sensitive locations are not included in our app. Any species for which records have their locality data obscured or generalised (whether by the original data provider, or by the ALA itself) are excluded from the app."),

h4("14. How often is the app updated?"),
p("Our major data files from the ALA are re-downloaded roughly once every month. The current data returned by the app was downloaded on 1st July 2024."),
h4("15. How often is the app updated?"),
p("Our major data files from the ALA are re-downloaded roughly once every few months. The current data returned by the app was downloaded on 22nd October 2024."),

h4("15. How can I download data from the app?"),
h4("16. How can I download data from the app?"),
p("You can download any given generated list by clicking on the 'Download all obs CSV' button. This will download a CSV file containing all records within the target area (and buffer, if selected), not just the most recent records that are presented in the table."),

h4("16. What do the different symbols on the map represent?"),
h4("17. What do the different symbols on the map represent?"),
p("The blue markers represent a single record. The coloured circles represent clusters of points; the number in the centre of each circle shows how many records are within that cluster. Zooming in on the map will resolve these clusters into their individual points. If a cluster remains even when at the maximum zoom level, clicking it will resolve it into its individual points."),

h4("17. Why is the app called 'An Infinity of Lists'?"),
h4("18. Why is the app called 'An Infinity of Lists'?"),
p("The app's name is a reference to the book ", tags$a(href = "https://en.wikipedia.org/wiki/The_Infinity_of_Lists", 'The Infinity of Lists'), " by Italian author Umberto Eco."),
),
)
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ download_ala_obs(taxon = "Orthoptera")
infinitylistApp()
```

## Adapt infinitylist for other countries
## Adapt infinitylists for other countries

We have developed functions to assist users to create their own infinitylist for their chosen taxa and country. Check out the vignette which shows you how to do so!

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ download_ala_obs(taxon = "Orthoptera")
infinitylistApp()
```

## Adapt infinitylist for other countries
## Adapt infinitylists for other countries

We have developed functions to assist users to create their own
infinitylist for their chosen taxa and country. Check out the vignette
Expand Down

0 comments on commit 9658b21

Please sign in to comment.