diff --git a/docs/Fieldsurveys.qmd b/docs/Fieldsurveys.qmd index 11d7c25..842c35d 100644 --- a/docs/Fieldsurveys.qmd +++ b/docs/Fieldsurveys.qmd @@ -94,7 +94,6 @@ If you want to play around with the app before setting up one for your case, fee ***Note:*** You may need to add Python to `PATH` if you’ve installed Python, but typing `python` on the command line doesn’t seem to work. Follow instructions [here](https://realpython.com/add-python-to-path/ "Add Python path"). ::: - - Data CSV files ([Data CSV files]) - `survey.yaml` that is customized to your use case (Make sure Data CSV files are ready before this step) @@ -105,11 +104,17 @@ If you want to play around with the app before setting up one for your case, fee Please complete all the required information fields and then you can download your file from [*this location*](https://nafcillincat.shinyapps.io/survey_config_generator/ "Survey App config generator"). ::: + ::: {.callout-warning collapse="true" appearance="simple"} + ## Do not rename survey.yaml file + + The file you download should be named `survey.yaml`. Please do not rename it, else the app won't work as expected. + ::: + - keyfile.json ([keyfile.json]) ## Data CSV files -If you do not know what a CSV file is or how to create one, read this [article](https://www.computerhope.com/issues/ch001356.htm) to get you started. The app requires users to upload data CSV files. These CSV files should contain the data that the user wants to collect during the survey. The CSV files must have the following headers (first line) in the specified order: +If you do not know what a CSV file is or how to create one, read this [article](https://www.computerhope.com/issues/ch001356.htm) to understand what CSV files are. The app requires users to upload data CSV files. These CSV files should contain the data that the user wants to collect during the survey. The CSV files must have the following headers (first line) in the specified order: 1. Common Name 2. Genus @@ -130,6 +135,14 @@ ACMA,Bigleaf maple,Acer,macrophyllum Ensure your CSV file follows the required format before uploading. You can use multiple CSV files, one for each survey type (e.g., plants, trees, grasses). +Create your desired CSV file using [this website](https://tableconvert.com/csv-generator "CSV generator website") or Google sheets + +![*Using [tableconvert website](https://tableconvert.com/csv-generator "CSV generator website") for CSV generation*](assets/download_csv_file.gif) + +Once the CSV file is downloaded, rename the file to something more readable like `birds.csv`, `trees.csv`from the existing name of `tableConvert.com_ypnog1.csv` + +Do it for other files if you have more than one data CSV file. + ## keyfile.json To download the `keyfile.json` for your Google Cloud account as a first-time user, follow these steps: diff --git a/docs/assets/download_csv_file.gif b/docs/assets/download_csv_file.gif new file mode 100644 index 0000000..4c079f1 Binary files /dev/null and b/docs/assets/download_csv_file.gif differ diff --git a/docs/index.html b/docs/index.html index fe62464..1726b58 100644 --- a/docs/index.html +++ b/docs/index.html @@ -279,13 +279,29 @@

Prerequisites

Please complete all the required information fields and then you can download your file from this location.

+ +
+ +
+
+

The file you download should be named survey.yaml. Please do not rename it, else the app won’t work as expected.

+
+

  • keyfile.json (keyfile.json)

    • Data CSV files

    -

    If you do not know what a CSV file is or how to create one, read this article to get you started. The app requires users to upload data CSV files. These CSV files should contain the data that the user wants to collect during the survey. The CSV files must have the following headers (first line) in the specified order:

    +

    If you do not know what a CSV file is or how to create one, read this article to understand what CSV files are. The app requires users to upload data CSV files. These CSV files should contain the data that the user wants to collect during the survey. The CSV files must have the following headers (first line) in the specified order:

    1. Common Name
    2. Genus
      3. @@ -300,6 +316,15 @@

      Data CSV files

      ARGL,Big berry manzanita,Arctostaphylos,glauca ACMA,Bigleaf maple,Acer,macrophyllum

      Ensure your CSV file follows the required format before uploading. You can use multiple CSV files, one for each survey type (e.g., plants, trees, grasses).

      +

      Create your desired CSV file using this website or Google sheets

      +
      +
      +

      +
      Using tableconvert website for CSV generation
      +
      +
      +

      Once the CSV file is downloaded, rename the file to something more readable like birds.csv, trees.csvfrom the existing name of tableConvert.com_ypnog1.csv

      +

      Do it for other files if you have more than one data CSV file.

    keyfile.json

    @@ -384,7 +409,7 @@

    survey.yaml file

  • Google Drive Folder Id
    • - -
    +

    To get the image URL directly from the browser, follow these steps:

      @@ -416,7 +441,7 @@

      Run the app on 
      fieldsurveys

      Follow the instructions on the screen to select your survey.yaml, data CSV files, and keyfile.json. It will then ask you for the directory where you want to store the app. Once you have provided all the necessary information, the app will be created in the specified directory.

      - -
      +

      If running fieldsurveys on the Windows Powershell/Command Prompt throws an error stating

      fieldsurveys : The term 'fieldsurveys' is not recognized as the name of a cmdlet, function, script file, or operable