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

Ayuda para modificar README.md #30

Open
NPJuncal opened this issue Jul 27, 2023 · 9 comments
Open

Ayuda para modificar README.md #30

NPJuncal opened this issue Jul 27, 2023 · 9 comments
Assignees

Comments

@NPJuncal
Copy link
Collaborator

Modifique el archivo README.rmd para añadir texto pero ahora no se como hacer que este modifique el de README.md

Cuando clico en knit el proceso se interrumpe... no se muy bien que estoy haciendo mal.

@NPJuncal
Copy link
Collaborator Author

Ademas me gustaria subir un esquema pero no se como subir una imagen

@Julenasti
Copy link
Collaborator

Hola Nerea,

Dado que el output del .rmd es github_document te lo renderiza automáticamente en .md por lo que el archivo .md se actualiza automáticamnete cuando corres el .rmd. En .rmd puedes especificarle el tipo de output que desees en el yaml: https://bookdown.org/yihui/rmarkdown/output-formats.html

Yo he hecho la prueba renderizando tu .rmd sin cambiar nada y sí que me lo renderiza bien. Puedes indicar el error que te da?

Añadir imágenes a .rmd es super fácil en el visual mode (insert -> image) que básicamente por debajo genera una carpeta de imágenes y lo lee incluyendo el path. Pero viendo el ejemplo de Paco de la imagen de la financiación entiendo que para paquetes no se añade una carpeta con las imágenes sino que el path se obtiene directamente de internet cómo lo hace él:
![](https://ecologyr.github.io/workshop/images/logos.png)
he visto que él lo pilla de aquí:
https://github.com/EcologyR/workshop/tree/main
Pero bueno, para esto a ver qué nos dice él...

@NPJuncal
Copy link
Collaborator Author

Hola Julen,
perdona que tarde tanto en verme esto. Cuando le doy a Knit en el archivo .rmd me dice que la ejecucion se ha interrumpido en la linea 19

La imagen ya esta :)

@NPJuncal
Copy link
Collaborator Author

si utilizo build_readme() el error es:

devtools::build_readme()
Error in read.dcf(path_desc) :
Line starting 'blue carbon ecosyste ...' is malformed!

@Julenasti
Copy link
Collaborator

Hola Nerea,
No te preocupes, yo también hoy es el primer día que miro el mail después de varias semanas ☺️
El error estaba en el DESCRIPTION. Hay que añadir tabulación cuando añades una nueva línea: https://stackoverflow.com/questions/59303030/devtools-error-in-read-dcfpath-desc-line-starting-this-corresponds-to
Lo he corregido y he hecho el commit así que haz el pull y todo OK. Te dara otro error porque los archivos que están en el NAMESPACE ya no se llaman así. Corrigelo porfa: https://stackoverflow.com/questions/26697727/what-does-error-in-namespaceexportns-exports-undefined-exports-mean

@Pakillo
Copy link
Member

Pakillo commented Aug 22, 2023

Hola!

Perdonad, se me había pasado esto.

Para incluir imágenes puedes incluir directamente el link a la imagen si esta está disponible públicamente en internet (e.g. https://github.com/EcologyR/templateRpackage/blob/e91a108483b661bf57567fe41247f92a3fb776dd/README.Rmd#L76).

Si la imagen no está disponible en otra parte, puedes añadirla al repo y enlazar al archivo. Creo que la convenció es guardar la imagen en la subcarpeta man/figures y enlazar ahí desde el README (e.g. https://github.com/VeruGHub/easyclimate/blob/3e06ffa9898844935f5361473b65e28fb5d11ce4/README.Rmd#L101). De hecho todas las figuras que genere el código de README.Rmd se guardarán ahí, en man/figures

HTH

@NPJuncal
Copy link
Collaborator Author

Listo! funciona.
He actualizado NAMESPACE y ya va. Lo que no entiendo es por que no aparece la funcion estimate_h en NAMEZPACE y las otras si si tambien la cree con el encabezado de ROxigen.
Sera porque como aparece dentro de otras funciones ROxigen interpreta que es una funcion secundaria?

@NPJuncal
Copy link
Collaborator Author

Hola Nerea, No te preocupes, yo también hoy es el primer día que miro el mail después de varias semanas ☺️ El error estaba en el DESCRIPTION. Hay que añadir tabulación cuando añades una nueva línea: https://stackoverflow.com/questions/59303030/devtools-error-in-read-dcfpath-desc-line-starting-this-corresponds-to Lo he corregido y he hecho el commit así que haz el pull y todo OK. Te dara otro error porque los archivos que están en el NAMESPACE ya no se llaman así. Corrigelo porfa: https://stackoverflow.com/questions/26697727/what-does-error-in-namespaceexportns-exports-undefined-exports-mean

Vuelvo a tener el mismo problema y por alguna razon ahora soy incapaz de solucionarlo. Actualice el readme directamente en .md sin querer. Ahora no soy capaz de actualizarlo usando el .rmd porque el knit se para en la linea 19 otra vez, y no se como actualizar el NAMESPACE :(
podrias volver a explicarmelo @Julenasti (perdon!)

@Julenasti
Copy link
Collaborator

Hola Nerea,
He hecho una pruebita rápida y he visto que se te había movido el código después de la línea 19. Lo he corregido y a mi ahora me renderiza bien. Just in case, instala el paquete badger si no lo tienes instalado ya. He visto que Paco está haciendo cambios así que cuidado con no solaparos mucho :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants