Continued work on practical R-Instat scripts for our library

[rdstern]

Our tutorials and other guides are usually in 2 forms.

1. There is a video
2. There is a practice guide

We are starting the process of getting a third form of these guides, namely as scripts. Here is tutorial 1 as a script;

Tutorial 1 r-script.zip

I like this new form to complement the two existing forms.

They should run block-by block easily and I suggest that is pretty quick and can add to our other tests of new versions. (It can't replace using the dialogs, because they might have changed from the saved script.)

I have also liked the role played by the Comments feature in each dialog. Usually it becomes a comment in the output and that should help, if we make the comments useful - i.e. don't always ignore it, so you get the default.

Now we find, similarly, it becomes a comment in the script, once you press To Script! Nice.

It is good to have well commented scripts in general. I suggest @rachelkg could improve on the comments in this draft, and work with @[email protected] to produce well commented scripts.

The scripts will also show weaknesses in our coding of the dialogs. I further suggest @beryl and @Rachel could query those weaknesses as issues, so the R-Instat code could be improved.

For example, in Tutorial 1 I suggest there is a better structure to the commands generated for the One Variable Summarise, compared to the One Variable Graph.

Then I suggest one of the developers could become the script "partner" working under @N-thony to get more consistency in the scripts for the different dialogs.

The example on graphs could be the first task. That can start any time, but is not to be merged for this week's update.

[berylwaswa]

Hello,
Below is the zipped file containing the r scripts for tutorial 1, tutorial 2 and the prepare menu practicals.

I have reviewed all three while testing R-Instat version .80 and they all worked fine.

R-Instat Scripts.zip

[berylwaswa]

Hello,
I have reviewed the computer skills needed for the R-Instat practical and created the r-script @rdstern. Please find it attached here.

computer_skills.zip

[derekagorhom]

@berylwaswa and @rachelkg while running through the script for the computer_skills.zip. i found this error below

i think we need to solve this since the PC name varies from one user to another.
either we remove this or make some change if we still want this there.

[berylwaswa]

@derekagorhom I think it's best to change it based on where it will be saved?

[berylwaswa]

I have just created another r-script for the first Express start practical, please find it attached.
@derekagorhom I found no errors here, you can check it too.

Express start r-script.zip

[derekagorhom]

@berylwaswa can you try

# Get the user's Documents directory
documents_path <- file.path(Sys.getenv("USERPROFILE"), "Documents")  # For Windows

# Save the R object as an RDS file with a proper name
saveRDS(object = data_book, file = file.path(documents_path, "computer_skills.RDS"))

let me know what you think about this

[berylwaswa]

@derekagorhom that worked fine there was no error throughout the script

[derekagorhom]

@rdstern , @berylwaswa
After looking through the five scripts i was sent i am only able to clear Tutorial 1 r-script.
The other scripts should work fine if they are on beryl laptop or if the user has the latest verion;

a. This is not really a problem now but it might be, assuming the user has an older version or uses an upgraded version of R-instat. This line will generate an error for the user in both cases.

b. This second will give an error because these are not the user's file path on their PCs so for save RDS i created

# Get the user's Documents directory
documents_path <- file.path(Sys.getenv("USERPROFILE"), "Documents")  # For Windows

# Save the R object as an RDS file with a proper name
saveRDS(object = data_book, file = file.path(documents_path, "computer_skills.RDS"))

and for the export also i did

# Get the user's Documents directory
documents_path <- file.path(Sys.getenv("USERPROFILE"), "Documents")  # For Windows

# Define the file path for the Excel file
excel_file_path <- file.path(documents_path, "dodoma_by_year.xlsx")

# Export the data frame to an Excel file
rio::export(x = data_book$get_data_frame(data_name = "dodoma_by_year"), file = excel_file_path)

but the issue i have is they look more of a VB structure than an R structure for saving or exporting. Any advise on the two codes will be appreciated.

[rachelkg]

I also can run through tutorial 1 with no problem but I come to an error in tutorial 2 on the last command about saving the data. In the prepare script it is the export to excel and the save commands that get errors. This is consistent with your findings @derekagorhom. Who do you think might be able to help with your questions about this? I don't think anyone in this thread has enough coding experience. Maybe @N-thony? Do you have any thoughts on Derek's questions?

[N-thony]

@rdstern , @berylwaswa After looking through the five scripts i was sent i am only able to clear Tutorial 1 r-script. The other scripts should work fine if they are on beryl laptop or if the user has the latest verion;

a. This is not really a problem now but it might be, assuming the user has an older version or uses an upgraded version of R-instat. This line will generate an error for the user in both cases.

Correct, this will give an error and not able to find the path when moving to a new version of R-Instat.
@berylwaswa @rachelkg @rdstern we can edit the code follow to dynamically get the file path.

# Current working directory
current_dir <- getwd()

# Construct the desired file path
file_path <- file.path(dirname(dirname(current_dir)), "Library", "Climatic", "climatic_guide_datasets.xlsx") 

# Importing the Dodoma Dataset into R-Instat

dodoma <- rio::import(file=file_path, guess_max=Inf, which=6)
data_book$import_data(data_tables=list(dodoma=dodoma))

b. This second will give an error because these are not the user's file path on their PCs so for save RDS i created

# Get the user's Documents directory
documents_path <- file.path(Sys.getenv("USERPROFILE"), "Documents")  # For Windows

# Save the R object as an RDS file with a proper name
saveRDS(object = data_book, file = file.path(documents_path, "computer_skills.RDS"))

and for the export also i did

# Get the user's Documents directory
documents_path <- file.path(Sys.getenv("USERPROFILE"), "Documents")  # For Windows

# Define the file path for the Excel file
excel_file_path <- file.path(documents_path, "dodoma_by_year.xlsx")

# Export the data frame to an Excel file
rio::export(x = data_book$get_data_frame(data_name = "dodoma_by_year"), file = excel_file_path)

but the issue i have is they look more of a VB structure than an R structure for saving or exporting. Any advise on the two codes will be appreciated.

They are R code, and this looks good to me, we can pass directly the path in export or save code

# Saving the data for later use to an RDS file in the user's Documents directory

saveRDS(file=file.path(Sys.getenv("USERPROFILE"), "Documents", "computer_skills.RDS"), object=data_book)

or you can create a variable that will store the document path and re-use if the codes are all in the same file

documents_path <- file.path(Sys.getenv("USERPROFILE"), "Documents")

and for the exports we can have

# Export the data frame to an Excel file in the user's Documents directory
rio::export(
  x = data_book$get_data_frame(data_name = "dodoma_by_year"),
  file = file.path(Sys.getenv("USERPROFILE"), "Documents", "dodoma_by_year.xlsx")
)

[derekagorhom]

@berylwaswa , @rachelkg
below is the updated code for R scripts to be put into R-instat, It contains all the previously sent files except the Prepare Menu practice r-script.R.
Can you kindly go through them and verify that they work well on your machines.
The updated code includes changes @N-thony suggested.
Kindly let me know how it goes.
Thanks

Updated R codes for the R-instat Scripts.zip

[berylwaswa]

@derekagorhom @N-thony

I have gone through the four scripts, 3 work fine; Tutorial 1, 2 and computer skills for R-Instat.

The express start script brings errors when I run it.

# Importing the Datasets in the Tutorial.RDS into R-Instat

data_book$import_RDS(data_RDS=new_RDS)
rm(new_RDS)

When I run the code above I get the error below

And when I run all the next lines that follow I get the error below;

The problems seems to be the data file cannot be found, I guess you have to edit something about the path again?

[N-thony]

@derekagorhom @N-thony

I have gone through the four scripts, 3 work fine; Tutorial 1, 2 and computer skills for R-Instat.

The express start script brings errors when I run it.

# Importing the Datasets in the Tutorial.RDS into R-Instat

data_book$import_RDS(data_RDS=new_RDS)
rm(new_RDS)

When I run the code above I get the error below

And when I run all the next lines that follow I get the error below;

The problems seems to be the data file cannot be found, I guess you have to edit something about the path again?

@derekagorhom you have missed some code as you can see below. Have you tested this before asking @berylwaswa to test again?

[derekagorhom]

@N-thony my mistake
i have given her another code to run and see if it works on her PC

[berylwaswa]

@derekagorhom here is another script you can check if it's okay, it works fine on my end.

fun with lists.zip

[berylwaswa]

@derekagorhom here is another script.

a tidy calculator r-script.zip

[berylwaswa]

@derekagorhom here is another r script to review.

fun with sequences.zip

[berylwaswa]

@derekagorhom here is another script, the last bit however may need editing please check it out.

a whole world of data.zip

[derekagorhom]

@derekagorhom here is another script, the last bit however may need editing please check it out.

a whole world of data.zip

@berylwaswa this zip file seems to have two issues with the rcode
You can find them below:

# Producing a Scatter Plot in R-Instat

diamonds <- data_book$get_data_frame(data_name="diamonds")
last_graph <- ggplot2::ggplot(data=diamonds, mapping=ggplot2::aes(colour=cut, y=color, x=clarity)) + ggplot2::geom_jitter(width=0.40, height=0.40) + theme_grey()
data_book$add_object(data_name="diamonds", object_name="last_graph", object_type_label="graph", object_format="image", object=check_graph(graph_object=last_graph))
data_book$get_object_data(data_name="diamonds", object_name="last_graph", as_file=TRUE)
rm(list=c("last_graph", "diamonds"))


# Producing a Scatter Plot in R-Instat

diamonds <- data_book$get_data_frame(data_name="diamonds")
last_graph <- ggplot2::ggplot(data=diamonds, mapping=ggplot2::aes(colour=cut, x=clarity, y=color)) + ggplot2::geom_jitter(width=0.40, height=0.40) + theme_grey()
data_book$add_object(data_name="diamonds", object_name="last_graph", object_type_label="graph", object_format="image", object=check_graph(graph_object=last_graph))
data_book$get_object_data(data_name="diamonds", object_name="last_graph", as_file=TRUE)
rm(list=c("last_graph", "diamonds"))

kindly have a look at the code above, i do not see any difference between these 2 but they were both added and they produce the same results. Is there any reason why both r code were added to the script?

The second one is the last line in that script (see below)

I can guess you downloaded the file from MICS but it is currently not available in the R-Instat Data library.
Can you kindly send the RDS file so that i can be added to the library.
Thanks.

[berylwaswa]

@derekagorhom I have made the necessary changes; now below is the new script.

a whole world of data.zip

The MICS data file is bigger than 25mbs so I'm sharing it with you on drive.

Thanks.

[berylwaswa]

mics.zip <https://drive.google.com/file/d/1oj7MmXm3WLoxnP_GDtCdLlfef6UbXIsw/view?usp=drive_web> Kind Regards, Beryl Waswa.

…

On Wed, Dec 4, 2024 at 2:32 PM Derrick Agorhom ***@***.***> wrote: @derekagorhom <https://github.com/derekagorhom> here is another script, the last bit however may need editing please check it out. a whole world of data.zip <https://github.com/user-attachments/files/17977703/a.whole.world.of.data.zip> @berylwaswa <https://github.com/berylwaswa> this zip file seems to have two issues with the rcode The first one is however simple: # Producing a Scatter Plot in R-Instat diamonds <- data_book$get_data_frame(data_name="diamonds") last_graph <- ggplot2::ggplot(data=diamonds, mapping=ggplot2::aes(colour=cut, y=color, x=clarity)) + ggplot2::geom_jitter(width=0.40, height=0.40) + theme_grey() data_book$add_object(data_name="diamonds", object_name="last_graph", object_type_label="graph", object_format="image", object=check_graph(graph_object=last_graph)) data_book$get_object_data(data_name="diamonds", object_name="last_graph", as_file=TRUE) rm(list=c("last_graph", "diamonds")) # Producing a Scatter Plot in R-Instat diamonds <- data_book$get_data_frame(data_name="diamonds") last_graph <- ggplot2::ggplot(data=diamonds, mapping=ggplot2::aes(colour=cut, x=clarity, y=color)) + ggplot2::geom_jitter(width=0.40, height=0.40) + theme_grey() data_book$add_object(data_name="diamonds", object_name="last_graph", object_type_label="graph", object_format="image", object=check_graph(graph_object=last_graph)) data_book$get_object_data(data_name="diamonds", object_name="last_graph", as_file=TRUE) rm(list=c("last_graph", "diamonds")) kindly have a look at the code above, i do not see any difference between these 2 but they were both added and they produce the same results. Is there any reason why both r code were added to the script? The second one is the last line in that script (see below) image.png (view on web) <https://github.com/user-attachments/assets/5441d65d-9846-4507-b9d3-f5d17f345c19> I can guess you downloaded the file from MICS but it is currently not available in the R-Instat Data library. Can you kindly send the RDS file so that i can be added to the library. Thanks. — Reply to this email directly, view it on GitHub <#9247 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AG2L3NGVVYXNCE6LVO3JZ3D2D26SZAVCNFSM6AAAAABRTTXYLWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKMJWGU3TKNZVGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[berylwaswa]

@derekagorhom here is another script. It works fine in the developer's version, but there is an error in the 0.8.0 version when plotting a multiple-line plot.

line plots.zip