From 76853dfadb0eebcce3292c12186cdc03909b8c38 Mon Sep 17 00:00:00 2001 From: Henri Date: Wed, 10 Dec 2025 15:52:23 +0200 Subject: [PATCH 1/4] Update instructions, after fetching they were causing some problems --- inst/user_doc/user_instructions.md | 12 +- inst/user_instructions.html | 290 ----------------------------- 2 files changed, 6 insertions(+), 296 deletions(-) delete mode 100644 inst/user_instructions.html diff --git a/inst/user_doc/user_instructions.md b/inst/user_doc/user_instructions.md index 541ce12..8dc9e45 100644 --- a/inst/user_doc/user_instructions.md +++ b/inst/user_doc/user_instructions.md @@ -11,7 +11,7 @@ pagetitle: fieldactivity In order to use the application, you should have a site account registered. If you don’t have an account yet, see the contact section for requesting one, otherwise you should be able to fill in the provided sitename and password to login. -![Login page](loginpage.png) +![Login page](images_user_instructions/loginpage.png) @@ -22,21 +22,21 @@ The UI of the application is simple, but we will provide an overview of what fun 1. Change the language between English and Finnish. 2. Check the sitename you have logged in with. Next to this field, by pressing plus sign (+), it gives an option to logout. -![Overview of layout of the application](Layout.png) +![Overview of layout of the application](images_user_instructions/Layout.png) 3. Change the shown subset of the events based on the type of events, block and year. As a default, all of the events from all of the (available) blocks and years are visible for the user. With the first option menu, the user is able to select which type of events she wants to keep visible on the summary table. With the second and third option menus, the user can pick the block and the year respectively to be displayed. If there are multiple events displayed, on the bottom of the table there is a navigation tool to switch the shown page. -![Summary table of the events](Eventtable.png) +![Summary table of the events](images_user_instructions/Eventtable.png) ### Filling in events Options for filling in the event will open, when pressing the *Add event* button. Start filling in the management event information by first choosing the block wherein the event has occurred, the name of this activity/event and a date for when it was conducted. One may also provide a short description that will be visible in the event table and later on give a quick reminder to which occurrence the event was related. -![Adding a new event](Addevent.png) +![Adding a new event](images_user_instructions/Addevent.png) After choosing the type of activity, one should fill in the data about this activity. Different types of activities have different fields to be filled in, for example, after choosing tillage one should fill in the type of tillage, how the tillage was implemented and what the depth of the tillage was. Required option fields are marked with a star sign (*). @@ -51,7 +51,7 @@ Here are some notes that generally apply to all of the activities and that are g - **Events can be modified after saving them**, so there is no need to stress about doing something irreversible. -![Example of the view for filling in the (tilling) event](eventexample_1.png) +![Example of the view for filling in the (tilling) event](images_user_instructions/eventexample_1.png) ### Clone event @@ -82,4 +82,4 @@ You may contact us, if you are facing one or several of the following situations - You want to request a feature that is currently not available - You want to know more about the app -Regarding the new features and bug fixes, you can also fill in a github issue [**here**](https://github.com/Ottis1/fieldactivity/issues) without contacting us. +Regarding the new features and bug fixes, you can also fill in a github issue [**here**](https://github.com/PecanProject/fieldactivity/issues) without contacting us. diff --git a/inst/user_instructions.html b/inst/user_instructions.html deleted file mode 100644 index 4f5b119..0000000 --- a/inst/user_instructions.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - - - - - - - - - -fieldactivity - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
-

Login

-

In order to use the application, you should have a site account registered. If you don’t have an account yet, see the contact section for requesting one, otherwise you should be able to fill in the provided sitename and password to login.

-
- -

Login page view

-
-
-
-

Layout

-

The UI of the application is simple, but we will provide an overview of what functionalities and views the user can utilise.

-
    -
  1. Change the language between English and Finnish.
    2. -
  2. Check the sitename you have logged in with.
    3. -
  3. Change the shown subset of the events based on the type of events, block and year.
    4. -
-
- -

Overview of layout of the application

-
-
-
-

Filling in events

-

Start filling in the management event information by first choosing the block wherein the event has occurred, the name of this activity/event and a date for when it was conducted. One may also provide a short description that will be visible in the event table and later on give a quick reminder to which occurrence the event was related.

-

After choosing the type of activity, one should fill in the data about this activity. Different types of activities have different fields to be filled in, for example, after choosing tillage one should fill in the type of tillage, how the tillage was implemented and what the depth of the tillage was.

-

Here are some notes that generally apply to all of the activities and that are good to keep in mind when filling in the form:

-
    -

  • Every event has to be logged in as its own event. In other words, even though some of the events can happen simultaneously and can in one’s mind be summarised as one event, it may require two or more records in application. For example tillage and sowing should be handled separately even in reality they happened simultaneously or back to back.

    • -

  • Pay attention to the units and in which form the application wants the numeric values. Units can change within the same form as some fields may request for example kg/ha while other fields may require t/ha. However, the desired unit is stated in the field so guessing is not required. It also doesn’t matter if the decimal point is indicated with “.” or “,”, the application recognizes both practices.

    • -

  • The application indicates with red border lines, if some required value is missing from the form. It is not usually required to fill in all of the fields and some of the fields may be difficult even for farmers to fill in. However, we hope that the user tries to fill in the events with care and as accurately as they are able to. This ensures that the data is valid for future usage in research purposes.

    • -

  • Events can be modified after saving them, so there is no need to stress about doing something irreversible.

    • -
-
- -

Example of the view for filling in the (tilling) event

-
-
-
-

Purpose of the application

-

The application is created to collect data of the field management events in a uniform way. The data collected through this application is used in the ecosystem models with a purpose to simulate carbon and other greenhouse gas exchanges in the field. Field management events play a key role in estimating such matters in agricultural environments.

-
-
-

Contact information

-

Henri Kajasilta           [Eng / Fin]
-Istem Fer                           [Eng]

-

You may contact us, if you are facing one or several of the following situations:

-
    -
  • Add (your) site to the application
    -
    • -
  • Reset the site/user password
    -
    • -
  • Report a possible bug in the application
    -
    • -
  • You want to request a feature that is currently not available
    -
    • -
  • You want to know more about the app
    • -
-

Regarding the new features and bug fixes, you can also fill in a github issue here without contacting us.

-
- - - - -
- - - - - - - - - - - - - - - From 5cb8c6bbcf1fee2b7132287b9007ceea6db58584 Mon Sep 17 00:00:00 2001 From: HenriKajasilta <92798719+HenriKajasilta@users.noreply.github.com> Date: Wed, 10 Dec 2025 16:09:26 +0200 Subject: [PATCH 2/4] Update R-CMD-check.yaml Ignore building vignettes. --- .github/workflows/R-CMD-check.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index cd53d35..ab10abe 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -31,5 +31,9 @@ jobs: - name: Check run: | options(crayon.enabled = TRUE) - rcmdcheck::rcmdcheck(args = "--no-manual", error_on = "error") + rcmdcheck::rcmdcheck( + build_args = "--no-build-vignettes", + args = c("--no-manual", "--no-vignettes"), + error_on = "error" + ) shell: Rscript {0} From b2c1daa11231601c75dccd01d0aafb1eb516d837 Mon Sep 17 00:00:00 2001 From: HenriKajasilta <92798719+HenriKajasilta@users.noreply.github.com> Date: Wed, 10 Dec 2025 16:18:29 +0200 Subject: [PATCH 3/4] Update R-CMD-check.yaml Use a bit older R version. --- .github/workflows/R-CMD-check.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index ab10abe..b0e283b 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -23,6 +23,8 @@ jobs: - uses: actions/checkout@v2 - uses: r-lib/actions/setup-pandoc@v2 - uses: r-lib/actions/setup-r@v2 + with: + r-version: '4.4.3' - name: Install dependencies run: | install.packages(c("remotes", "rcmdcheck")) From fb7affc9b9e8d35bb23bb9d8b3fb3950238021eb Mon Sep 17 00:00:00 2001 From: Henri Date: Wed, 10 Dec 2025 16:33:04 +0200 Subject: [PATCH 4/4] Put instructions back --- inst/user_instructions.html | 551 ++++++++++++++++++++++++++++++++++++ 1 file changed, 551 insertions(+) create mode 100644 inst/user_instructions.html diff --git a/inst/user_instructions.html b/inst/user_instructions.html new file mode 100644 index 0000000..2c1ac3c --- /dev/null +++ b/inst/user_instructions.html @@ -0,0 +1,551 @@ + + + + + + + + + + + + + +fieldactivity + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+

Login

+

In order to use the application, you should have a site account +registered. If you don’t have an account yet, see the contact section +for requesting one, otherwise you should be able to fill in the provided +sitename and password to login.

+
+Login page +
Login page
+
+
+
+

Layout

+

The UI of the application is simple, but we will provide an overview +of what functionalities and views the user can utilise.

+
    +
  1. Change the language between English and Finnish.
    2. +
  2. Check the sitename you have logged in with. Next to this field, by +pressing plus sign (+), it gives an option to logout.
    3. +
+
+Overview of layout of the application +
Overview of layout of the application
+
+
    +
  1. Change the shown subset of the events based on the type of events, +block and year.
    2. +
+

As a default, all of the events from all of the (available) blocks +and years are visible for the user. With the first option menu, the user +is able to select which type of events she wants to keep visible on the +summary table. With the second and third option menus, the user can pick +the block and the year respectively to be displayed. If there are +multiple events displayed, on the bottom of the table there is a +navigation tool to switch the shown page.

+
+Summary table of the events +
Summary table of the events
+
+
+
+

Filling in events

+

Options for filling in the event will open, when pressing the Add +event button. Start filling in the management event information by +first choosing the block wherein the event has occurred, the name of +this activity/event and a date for when it was conducted. One may also +provide a short description that will be visible in the event table and +later on give a quick reminder to which occurrence the event was +related.

+
+Adding a new event +
Adding a new event
+
+

After choosing the type of activity, one should fill in the data +about this activity. Different types of activities have different fields +to be filled in, for example, after choosing tillage one should fill in +the type of tillage, how the tillage was implemented and what the depth +of the tillage was. Required option fields are marked with a star sign +(*).

+

Here are some notes that generally apply to all of the activities and +that are good to keep in mind when filling in the form:

+
    +

  • Every event has to be logged in as its own event. In other words, +even though some of the events can happen simultaneously and can in +one’s mind be summarised as one event, it may require two or more +records in application. For example tillage and sowing should be handled +separately even in reality they happened simultaneously or back to +back.

    • +

  • Pay attention to the units and in which form the application +wants the numeric values. Units can change within the same form as some +fields may request for example kg/ha while other fields may require +t/ha. However, the desired unit is stated in the field so guessing is +not required. It also doesn’t matter if the decimal point is indicated +with “.” or “,”, the application recognizes both practices.

    • +

  • The application indicates with red border lines, if some required +value is missing from the form. It is not usually required to fill in +all of the fields and some of the fields may be difficult even for +farmers to fill in. However, we hope that the user tries to fill in the +events with care and as accurately as they are able to. This ensures +that the data is valid for future usage in research purposes.

    • +

  • Events can be modified after saving them, so +there is no need to stress about doing something irreversible.

    • +
+
+Example of the view for filling in the (tilling) event +
Example of the view for filling in the (tilling) +event
+
+
+
+

Clone event

+

Any event can be cloned, and as the action implies, it creates a new +event holding the same information as the event it was cloned from. +However, like any other event, this new cloned event can be modified. +This is practical for instance in situations wherein the same field +management events have been conducted to several blocks. By cloning the +event, the user can then easily change a block and save the record in +order to have the same management event for several sites. The Clone +event button is found next to the Add event button.

+
+
+

Delete event

+

When choosing an event from the summary table, it is possible to edit +the chosen event. Within this editing option, it is also possible to +delete the event.

+
+
+

Purpose of the application

+

The application is created to collect data of the field management +events in a uniform way. The data collected through this application is +used in the ecosystem models with a purpose to simulate carbon and other +greenhouse gas exchanges in the field. Field management events play a +key role in estimating such matters in agricultural environments.

+
+
+

Contact information

+

Henri Kajasilta           [Eng / Fin]
+Istem Fer                           [Eng]

+

You may contact us, if you are facing one or several of the following +situations:

+
    +
  • Add (your) site to the application
    +
    • +
  • Reset the site/user password
    +
    • +
  • Report a possible bug in the application
    +
    • +
  • You want to request a feature that is currently not available
    +
    • +
  • You want to know more about the app
    • +
+

Regarding the new features and bug fixes, you can also fill in a +github issue here +without contacting us.

+
+ + + + +
+ + + + + + + + + + + + + + +