RKWard on Windows

From RKWard
(Difference between revisions)
Jump to: navigation, search
(0.7.0b)
 
(30 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
[[Category:User Documentation]]
 
[[Category:User Documentation]]
  
== Status ==
+
== Installing the official release ==
RKWard on Windows is can be used productively, and many users do so, today. However, others users still experience quirks, up to complete failure to function. Most of the time, these issues can be resolved. First, check the list of known issues, below. If problems persist, please [[Contact|let us know]], so we can work on a solution.
+
  
== Known issues and work-arounds ==
+
Since version 0.7.0 installation of RKWard on windows should be straight-forward: Simply download and run the [https://download.kde.org/stable/rkward/0.7.0/win32/rkward-0.7.0b-R-3.4.4-KF5-5.43.exe latest installer]. The installer includes RKWard 0.7.0b, R 3.4.4, and all required KF5 frameworks (version 5.43).
(Please use the [[Contact|bug trackers]] to report issues. This section is only meant to document some deficiencies, which are encountered relatively frequently.)
+
  
* Some users have reported that functions trying to download from the internet (e.g. package installation) will fail, in both R and RKWard on Windows. In this case, please try running "setInternet2(TRUE)" in the R Console after starting RKWard (as per [http://cran.r-project.org/bin/windows/base/rw-FAQ.html#The-Internet-download-functions-fail_002e]).
+
For installing older, KDE4-based versions of RKWard, refer to the instructions an an [https://rkward.kde.org/index.php?title=RKWard_on_Windows&oldid=1474 earlier version of this page].
  
* Some versions of the Symantec virus scanner are known to report false positives for "knotify4.exe" and "keditfiletype.exe", based on heuristic detection. If in any doubt, please contact your virus scanner's vendor.
+
== Installing development snapshots ==
  
* Occasionally, users see the message "Error during handshake with backend process. Expected token ''something'', received token ''something slightly shorter''" while starting RKWard. We are still investigating the cause of this error. However, this error occurs sporadically, only. Simply close RKWard, and start it again. If this error occurs very frequently, please [[Contact|contact us]].
+
Development snapshot are available from https://binary-factory.kde.org/job/RKWard_Nightly_mingw64/ . Note that these are built, automatically, and provided without any human testing. Back up your data, before using these.
  
* Occasionally, users report seeing the message "Could not start process Cannot talk to klauncher: The name org.kde.klauncher was not provided by any .service files.", along with various symptoms. Typically this indicates that more than one version of KDE is running on the computer at the same time, e.g. after updating the KDE installation. The easiest solution is to reboot.
+
== Updating R inside the RKWard installation ==
  
== Installing ==
 
 
=== Standard installation: Complete installation bundle ===
 
 
The easiest way to install RKWard on Windows is using the '''[http://sourceforge.net/projects/rkwardextras/files/RKWard-0.5.7_R-2.13.2_KDE-4.7.0_bundle.exe/download binary installation bundle]'''.
 
# Simply download the above file and double-click the downloaded .exe-file.
 
# You will be prompted for an installation folder. This could be C:\Programs\, but also a network share, a USB disk, or almost any other folder. A subdirectory "RKWard" will be created in this folder.
 
# You may want to drag-and-drop the "RKWard"-icon from the installation-folder to your desktop or to another easily accessible location.
 
 
'''That's all'''! For more information see http://sourceforge.net/projects/rkwardextras/files/Readme.html/download . At the time of this writing, the bundle includes RKWard 0.5.7, KDE 4.7.0, and R 2.13.2. If you want to use a custom installation of KDE and / or R, use the "RKWard on Windows installer", instead (see below).
 
 
 
 
=== Custom installation: RKWard on Windows installer ===
 
==== Pre-requisites ====
 
You need to install R and KDE '''before''' you can install RKWard.
 
 
===== R =====
 
A windows installer is available at http://cran.r-project.org/bin/windows/base/ .
 
 
Installation should be straightforward and does not require any special settings. In cases of doubt, extensive documentation is available from the same url.
 
 
===== KDE =====
 
Generic instructions for installing KDE on Windows are available at http://techbase.kde.org/Projects/KDE_on_Windows/Installation .
 
For RKWard, proceed as follows:
 
# Download the [http://www.winkde.org/pub/kde/ports/win32/installer/kdewin-installer-gui-latest.exe KDE Windows installer] and run it. For RKWard 0.5.7, KDE 4.7.0 or later is required on Windows.
 
# '''Be sure to select MinGW4 as compiler mode''' on the third page of the installer.
 
# Install the following KDE packages:
 
#* kate, okular
 
#* (many additional packages will be installed, automatically).
 
 
==== Installing RKWard ====
 
The RKWard installer itself is available at https://sourceforge.net/projects/rkward/files/Current_Stable_Releases/install_rkward_0.5.7-3.exe/download . In the installer you will need to specify the R and KDE installation directories.
 
 
== Updating R / KDE / RKWard ==
 
 
=== Updating RKWard itself ===
 
The easiest way to update RKWard itself in an existing installation is to simply use the RKWard on Windows installer, and to point it to the correct location. In general, the latest version of RKWard should work with all reasonably recent versions of KDE and R.
 
 
=== Updating KDE ===
 
To update the KDE portion of an existing RKWard installation, you can use the KDE windows installer as described in the "Custom installation"-section, above.
 
* In general, KDE releases are "binary compatible" with earlier versions of KDE. Thus, in theory, updating KDE should not be a problem. In practice, we recommend to back up your KDE installation, first.
 
* As usual, you need to choose the MinGW4-compiler.
 
* We do intend to update the complete installation bundle for important new releases of KDE. So consider waiting until a complete installation bundle is ready, instead.
 
 
=== Updating R ===
 
 
To update R, use the R installer.
 
To update R, use the R installer.
 
* Often, new releases of R will work with old versions of RKWard, especially, for patch releases (those differing only in the third section of the version number), generally there should not be any problems. However, it is always a good idea to use the latest version of RKWard with the latest version of R. If in any doubt, back up your installation, first.
 
* Often, new releases of R will work with old versions of RKWard, especially, for patch releases (those differing only in the third section of the version number), generally there should not be any problems. However, it is always a good idea to use the latest version of RKWard with the latest version of R. If in any doubt, back up your installation, first.
* You can either install R to the exact same location as before. In this case nothing special needs to be done. However, if your R installation path contains a version number, or is changed in any other way, then you will need to either
+
* You will need to install to [Your\RKWard\Installation\]KDE\libs\R .
** Run the RKWard on Windows installer, again, after updating R or
+
** Open [Your\RKWard\Installation\]KDE\bin\rkward.bat in a text editor, and adjust the line that starts with "SET R_EXECUTABLE=" to point to the new installation path.
+
 
* Remember to update your R packages after updating R.
 
* Remember to update your R packages after updating R.
  
 +
== Known issues and work-arounds ==
 +
(Please use the [[Contact|bug trackers]] to report issues. This section is only meant to document some deficiencies, which are encountered relatively frequently.)
 +
 +
* Some versions of the Symantec '''virus scanner''' are known to report false positives for "knotify4.exe" and "keditfiletype.exe", based on heuristic detection. If in any doubt, please contact your virus scanner's vendor.
 +
 +
If you run into issues not listed above, or you can provide further insight on the above issues, please do not hesitage to [[Contact|contact]] us!
  
 
== Compiling RKWard from source on Windows ==
 
== Compiling RKWard from source on Windows ==
  
=== Using ''emerge'' (recommended) ===
+
# Set up "craft" as detailed, here: https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Windows .
 
+
# Set up emerge as detailed, here: http://techbase.kde.org/Getting_Started/Build/KDE4/Windows/emerge .
+
 
# run
 
# run
   emerge rkward
+
   craft -i rkward
  
This should be all you need to fetch rkward and all dependencies (including R). Note that this will take several hours to complete.
+
This should be all you need to fetch rkward and all dependencies (including R). Note that this may take several hours to complete.
  
 
==== Notes ====
 
==== Notes ====
Line 84: Line 38:
 
* Currently this has only been tested with the MinGW(4) compiler. You are encouraged to try compiling using MSVC, but quite likely you will run into some problems. Report those on the [[Contact|mailing list]], and we will take care of them.
 
* Currently this has only been tested with the MinGW(4) compiler. You are encouraged to try compiling using MSVC, but quite likely you will run into some problems. Report those on the [[Contact|mailing list]], and we will take care of them.
  
* At times, compilation using emerge will fail. If the build fails on the R or RKWard packages themselves, let us know on the [[Contact|mailing list]]. If the build fails at an earlier stage (qt / kdelibs / kdebase), you may want to check http://winkde.org/pub/kde/ports/win32/dashboard/ to see whether this is a problem with your particular setup, or a general problem.
+
* At times, compilation using craft will fail. If the build fails on the R or RKWard packages themselves, let us know on the [[Contact|mailing list]]. If the build fails at an earlier stage (qt / kdelibs / kdebase), you may want to ask for help on [kde-windows@kde.org the KDE windows mailing list].
  
* It is not easily possible to re-use an existing R installation in this approach. Should this be a hard requirement, please use the precompiled package, or try the instructions for fully custom compilation, below.
+
* To customize your installation of R or RKWard, edit / refer to the following python files
 +
** ''CRAFT\ROOT''\etc\blueprints\locations\craft-blueprints-kde\extragear\rkward\rkward\rkward.py
 +
** ''CRAFT\ROOT''\etc\blueprints\locations\craft-blueprints-kde\binary\_win\r-base\r-base.py
  
 
=== Custom compilation / Packaging ('''not''' recommended for most users) ===
 
=== Custom compilation / Packaging ('''not''' recommended for most users) ===
For info on compiling RKWard of Linux/BSD/similar systems see [[Building_RKWard_From_Source]]. The same information basically applies on Windows - once you have installed all requirements. For more information, refer to the [[RKWard_on_Windows/Packaging|developers' notes on packaging RKWard for Windows]].
+
For more information, refer to the [[RKWard_on_Windows/Packaging|developers' notes on packaging RKWard for Windows]].
  
 
=== Debugging / further info ===
 
=== Debugging / further info ===
 
See http://techbase.kde.org/Development/Tutorials/Debugging/Debugging_on_MS_Windows in the KDE wiki.
 
See http://techbase.kde.org/Development/Tutorials/Debugging/Debugging_on_MS_Windows in the KDE wiki.

Latest revision as of 10:02, 17 April 2018


This page has been marked as needing an improvement. This means the page is incomplete, badly structured or otherwise in need of significant improvements. Most importantly, a walkthrough for the installer is needed

Contents

[edit] Installing the official release

Since version 0.7.0 installation of RKWard on windows should be straight-forward: Simply download and run the latest installer. The installer includes RKWard 0.7.0b, R 3.4.4, and all required KF5 frameworks (version 5.43).

For installing older, KDE4-based versions of RKWard, refer to the instructions an an earlier version of this page.

[edit] Installing development snapshots

Development snapshot are available from https://binary-factory.kde.org/job/RKWard_Nightly_mingw64/ . Note that these are built, automatically, and provided without any human testing. Back up your data, before using these.

[edit] Updating R inside the RKWard installation

To update R, use the R installer.

  • Often, new releases of R will work with old versions of RKWard, especially, for patch releases (those differing only in the third section of the version number), generally there should not be any problems. However, it is always a good idea to use the latest version of RKWard with the latest version of R. If in any doubt, back up your installation, first.
  • You will need to install to [Your\RKWard\Installation\]KDE\libs\R .
  • Remember to update your R packages after updating R.

[edit] Known issues and work-arounds

(Please use the bug trackers to report issues. This section is only meant to document some deficiencies, which are encountered relatively frequently.)

  • Some versions of the Symantec virus scanner are known to report false positives for "knotify4.exe" and "keditfiletype.exe", based on heuristic detection. If in any doubt, please contact your virus scanner's vendor.

If you run into issues not listed above, or you can provide further insight on the above issues, please do not hesitage to contact us!

[edit] Compiling RKWard from source on Windows

  1. Set up "craft" as detailed, here: https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Windows .
  2. run
 craft -i rkward

This should be all you need to fetch rkward and all dependencies (including R). Note that this may take several hours to complete.

[edit] Notes

  • Currently this has only been tested with the MinGW(4) compiler. You are encouraged to try compiling using MSVC, but quite likely you will run into some problems. Report those on the mailing list, and we will take care of them.
  • At times, compilation using craft will fail. If the build fails on the R or RKWard packages themselves, let us know on the mailing list. If the build fails at an earlier stage (qt / kdelibs / kdebase), you may want to ask for help on [kde-windows@kde.org the KDE windows mailing list].
  • To customize your installation of R or RKWard, edit / refer to the following python files
    • CRAFT\ROOT\etc\blueprints\locations\craft-blueprints-kde\extragear\rkward\rkward\rkward.py
    • CRAFT\ROOT\etc\blueprints\locations\craft-blueprints-kde\binary\_win\r-base\r-base.py

[edit] Custom compilation / Packaging (not recommended for most users)

For more information, refer to the developers' notes on packaging RKWard for Windows.

[edit] Debugging / further info

See http://techbase.kde.org/Development/Tutorials/Debugging/Debugging_on_MS_Windows in the KDE wiki.

Personal tools
Namespaces

Variants
Actions
RKWard
Documentation
wiki
Toolbox
Affiliations