Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rcmd check warning: "unicode encoding in documentation" #5

Closed
mrustl opened this issue Feb 23, 2021 · 4 comments
Closed

Rcmd check warning: "unicode encoding in documentation" #5

mrustl opened this issue Feb 23, 2021 · 4 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@mrustl
Copy link
Member

mrustl commented Feb 23, 2021

@hsonne any idea how I can resolve this?

See: https://github.com/KWB-R/kwb.pilot/runs/1960000020?check_suite_focus=true#step:9:348

Execution halted
                   \n preProc = `Druck_Arbeitsdruck`, \n preConc =
                   `Druck_Konzentrat`,\n nwp0 = 1.429162,\n vfrPerm0 =
                   800)", nwpr = "- ((1 - (nwpt / vfrPerm))) * 100"),
                   calc_list_name = c("Durchfluss Permeat", "Ausbeute",
                   "Leitf�higkeit Rezirkulation", "R�ckhalt",
                   "Druckverlust (Feed - Konzentrat)", "Flux",
                   "�berstr�mungsgeschwindigkeit", "Transmembrandruck",
                   "Normalisierter Permeatstrom", "Relativer
                   Permeatstrom"), calc_list_unit = c("l/h", "%",
                   "�S/cm", "%", "bar", "l/h/m2", "m/s", "bar", "l/h",
                   "%"), calc_paras = c("Durchfluss_Rohwasser",
                   "Durchfluss_Konzentrat", "Durchfluss_Rezirkulation",
                   "Druck_Arbeitsdruck", "Druck_Rohwasser",
                   "Druck_Konzentrat", "Druck_Permeat", "LF_Permeat",
                   "LF_Rohwasser", "LF_Konzentrat",
                   "Temperatur_Rohwasser"))
    Docs: function(df, calc_list = list(vfrPerm = "`Durchfluss_Rohwasser`
                   - `Durchfluss_Konzentrat`", yield =
                   "100*(`Durchfluss_Rohwasser` -
                   `Durchfluss_Konzentrat`) / `Durchfluss_Rohwasser`",
                   conLoop = "(`Durchfluss_Rohwasser`*`LF_Rohwasser` +
                   `Durchfluss_Rezirkulation`*`LF_Konzentrat`)/(`Durchfluss_Rohwasser`
                   + `Durchfluss_Rezirkulation`)", recovery = "100*(1 -
                   `LF_Permeat` / conLoop)", deltaPreProcConc =
                   "`Druck_Arbeitsdruck` - `Druck_Konzentrat`", flux =
                   "vfrPerm / (4 * 7.6)", cfv = "(`Durchfluss_Rohwasser`+
                   `Durchfluss_Rezirkulation`) / ((pi * 0.0095^2) * 1000
                   * 3600)", tmp = "((`Druck_Arbeitsdruck` +
                   `Druck_Konzentrat`) / 2) - `Druck_Permeat`", nwpt =
                   "normalised_permeate_flow(tempFeed =
                   `Temperatur_Rohwasser`, \n conLoop = `conLoop`,\n
                   vfrPerm = `vfrPerm`, \n vfrLoop =
                   `Durchfluss_Rezirkulation`,\n vfrFeed =
                   `Durchfluss_Rohwasser`, \n prePerm = `Druck_Permeat`,
                   \n preProc = `Druck_Arbeitsdruck`, \n preConc =
                   `Druck_Konzentrat`,\n nwp0 = 1.429162,\n vfrPerm0 =
                   800)", nwpr = "- ((1 - (nwpt / vfrPerm))) * 100"),
                   calc_list_name = c("Durchfluss Permeat", "Ausbeute",
                   "Leitf�higkeit Rezirkulation", "R�ckhalt",
                   "Druckverlust (Feed - Konzentrat)", "Flux",
                   "�berstr�mungsgeschwindigkeit", "Transmembrandruck",
                   "Normalisierter Permeatstrom", "Relativer
                   Permeatstrom"), calc_list_unit = c("l/h", "%",
                   "µS/cm", "%", "bar", "l/h/m2", "m/s", "bar", "l/h",
                   "%"), calc_paras = c("Durchfluss_Rohwasser",
                   "Durchfluss_Konzentrat", "Durchfluss_Rezirkulation",
                   "Druck_Arbeitsdruck", "Druck_Rohwasser",
                   "Druck_Konzentrat", "Druck_Permeat", "LF_Permeat",
                   "LF_Rohwasser", "LF_Konzentrat",
                   "Temperatur_Rohwasser"))
    Mismatches in argument default values:
      Name: 'calc_list_unit'
      Code: c("l/h", "%", "�S/cm", "%", "bar", "l/h/m2", "m/s", "bar", "l/h", 
            "%")
      Docs: c("l/h", "%", "µS/cm", "%", "bar", "l/h/m2", "m/s", "bar", "l/h", 
            "%")
@mrustl mrustl added the help wanted Extra attention is needed label Feb 23, 2021
@hsonne
Copy link
Member

hsonne commented Feb 23, 2021

Am besten nie und nimmer Umlaute verwenden!

@mrustl
Copy link
Member Author

mrustl commented Feb 23, 2021

Ja klar aber selbst das "µ" macht Probleme (hab ja alles in Unicode codiert....

z.B. https://github.com/KWB-R/kwb.pilot/blob/suleman/R/calculate_operational_parameters_berlin_f.R#L99

@hsonne
Copy link
Member

hsonne commented Feb 25, 2021

Can you try to replace \u00B5 with \xB5 and accordingly?

Unfortunately this suggestion is of the category: "I do not know what I do but I hope that it does what I want it to do".

mrustl added a commit that referenced this issue Feb 26, 2021
@mrustl
Copy link
Member Author

mrustl commented Feb 26, 2021

Your proposed fix also didnt work :-(.
But I found out that it might be an issue within encoding in Windows compared to Linux

See: r-lib/roxygen2#1121 someone having problems with the greek mu in Windows but not under Linux and he wrote a work-around....

@mrustl mrustl closed this as completed in e8199fa Feb 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants